Hi all, (cc. Inkscape devel, maybe there are some documentation wizzards out there)
I've started a bit of documentation work. The Doxyfile configuration file for doxygen has been updated to the latest version. I've also made some tweaks that I found useful, or want to try a bit. First hour I am using doxygen so...
Go to lib2geom's root and run doxygen. Then, you should get doc/html/index.html, which is the homepage of the generated documentation. As you can see, there is a lot to do.
Please read a bit of the doxygen manual if you want to contribute a lot.
Note 1: Doxygen can generate nice equations: http://www.stack.nl/~dimitri/doxygen/formulas.html Put your LaTeX equations between a pair of "\f$" commands: \f$ x = 1 \f$
Note 2: Doxygen makes use of special commands you can put in your code, such as: /** \brief Scales this vector to make it a unit vector (within rounding error). * * The current version tries to handle infinite coordinates gracefully, * but it's not clear that any callers need that. * * \pre \f$this \neq (0, 0)\f$ * \pre Neither component is NaN. * \post \f$-\epsilon<\left|this\right|-1<\epsilon\f$ */ void Point::normalize() { ...
It is worth checking out other commands like \param, \see and \return.
Note 3: The documentation is filled with "Geom::" namespace. I have not yet figured out how to tell doxygen to only document the Geom:: namespace and leave all other things (like std!!!!?!??!) out.
Note 4: Doxygen accepts two command styles: \pre and @pre. They can be mingled without a problem I think, but shall we try to use the slash? \file, \brief, etc.
Note 5: I'll be adding a lot of empty template documentation comments, so you don't have to think much about how to add documentation. This way, many people can help without much knowledge of doxygen.
Note 6: We should get a server to run this every day and put it on the web somewhere! (including a tar so people can download it?)
Cheers, Johan