Hi,
I've gotten back to trying to get more documentation straightened out and filled out. Some architechtural overview, getting started type details, etc.
Does anyone else want to lend a hand? :-)
Or more importantly are there any specifics I should look into filling out? That is, any areas people want me to look into, or any aspects that need special attention, etc.
Thanks.
On Mon, 2011-10-03 at 00:58 -0700, Jon Cruz wrote:
Hi,
I've gotten back to trying to get more documentation straightened out and filled out. Some architechtural overview, getting started type details, etc.
Does anyone else want to lend a hand? :-)
Or more importantly are there any specifics I should look into filling out? That is, any areas people want me to look into, or any aspects that need special attention, etc.
Thanks.
Hi Jon,
It's great to see you working on code documentation. I think that is a real weak point in Inkscape. I can't tell you the number of hours I've spent trying to figure out how things work when a simple comment or two in the code would have been sufficient for an explanation. I try to add comments to code I touch.
I see you just checked in lots of Doxygen fixes. I also noticed that the Doxygen link on the developer's page no longer works. It took me awhile to figure out that I can run the command "doxygen" on Linux to generate the documentation but this generates tons of errors, the first being a latex error:
See the LaTeX manual or LaTeX Companion for explanation. Type H <return> for immediate help. ...
l.125 \begin{align*} \mathbf{B}_{\mathbf{p}_0\mathbf{p}_1 \mathbf{p}_2}(t) &=...
What am I doing wrong?
Tav
On Oct 3, 2011, at 6:28 AM, Tavmjong Bah wrote:
I see you just checked in lots of Doxygen fixes. I also noticed that the Doxygen link on the developer's page no longer works. It took me awhile to figure out that I can run the command "doxygen" on Linux to generate the documentation but this generates tons of errors, the first being a latex error:
See the LaTeX manual or LaTeX Companion for explanation. Type H <return> for immediate help. ...
l.125 \begin{align*} \mathbf{B}_{\mathbf{p}_0\mathbf{p}_1 \mathbf{p}_2}(t) &=...
What am I doing wrong?
I'm not sure, as it is working fine for me.
Perhaps your Doxyfile was edited to change GENERATE_LATEX to be no longer set to NO.
On 3-10-2011 15:28, Tavmjong Bah wrote:
I see you just checked in lots of Doxygen fixes. I also noticed that the Doxygen link on the developer's page no longer works. It took me awhile to figure out that I can run the command "doxygen" on Linux to generate the documentation but this generates tons of errors, the first being a latex error:
See the LaTeX manual or LaTeX Companion for explanation. Type H<return> for immediate help. ...
l.125 \begin{align*} \mathbf{B}_{\mathbf{p}_0\mathbf{p}_1 \mathbf{p}_2}(t)&=...
What am I doing wrong?
I added two LaTeX packages for the Doxygen stuff, should work better now. (it takes a long while to check whether it actually works, so just shot off this mail before going to bed. it works for 2geom)
-Johan
Jon, I will be happy to lend a hand on this... Where would you like me to start or help..?? Regards Leo Jackson
________________________________ From: Jon Cruz <jon@...18...> To: inkscape-devel List inkscape-devel@lists.sourceforge.net Sent: Monday, October 3, 2011 3:58 AM Subject: [Inkscape-devel] Documentation
Hi,
I've gotten back to trying to get more documentation straightened out and filled out. Some architechtural overview, getting started type details, etc.
Does anyone else want to lend a hand? :-)
Or more importantly are there any specifics I should look into filling out? That is, any areas people want me to look into, or any aspects that need special attention, etc.
Thanks.
------------------------------------------------------------------------------ All the data continuously generated in your IT infrastructure contains a definitive record of customers, application performance, security threats, fraudulent activity and more. Splunk takes this data and makes sense of it. Business sense. IT sense. Common sense. http://p.sf.net/sfu/splunk-d2dcopy1 _______________________________________________ Inkscape-devel mailing list Inkscape-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/inkscape-devel
On 3-10-2011 9:58, Jon Cruz wrote:
Hi,
I've gotten back to trying to get more documentation straightened out and filled out. Some architechtural overview, getting started type details, etc.
Does anyone else want to lend a hand? :-)
Or more importantly are there any specifics I should look into filling out? That is, any areas people want me to look into, or any aspects that need special attention, etc.
What would help me a lot is a set of examples/templates on the wiki that I can cut and paste into the source and modify. What I am looking for in doc templates is ways to document: - a class - a method within a class - a C function - a method with arguments, specifying what each argument means - a method that returns something, specifying what is returned - exceptions that function may throw - how to refer to another class, method, or argument.
(this should just be a couple big fully featured templates)
Every time I want to document something, I end up searching the code base and the web for a long time to find out how to do 'standard' things...
Thanks a bunch, Johan
On 3-10-2011 9:58, Jon Cruz wrote:
Hi,
I've gotten back to trying to get more documentation straightened out and filled out. Some architechtural overview, getting started type details, etc.
Does anyone else want to lend a hand? :-)
Or more importantly are there any specifics I should look into filling out? That is, any areas people want me to look into, or any aspects that need special attention, etc.
Shall we exclude the 2geom dir from Inkscape's doxygen?
-Johan
participants (4)
-
Johan Engelen -
Jon Cruz -
Leo Jackson -
Tavmjong Bah