[certi-dev] CERTI documentation

[Eric Noulard]

Hi All,

As some of you may have followed we have a CERTI documentation effort
which is underway:
http://lists.nongnu.org/archive/html/certi-devel/2008-10/msg00014.html
http://lists.nongnu.org/archive/html/certi-devel/2008-10/msg00017.html

The on-going result may be browsed here:
http://www.nongnu.org/certi/certi_doc/index.html

(Developer doc hasn't been uploaded yet)

For those of you who are writing CERTI source code or patches
I'd like to add some comment/recommandation for doxygen documentation,

1) All the documentation should be written with doxygen markup
    http://www.stack.nl/~dimitri/doxygen/manual.html

2) API documentation
    should preferably be written in the header file (.hh) and not
    in the implementation/body file (.cc)
    Doxygen doesn't care about that but this more convenient
    for people reading headers.
    Moreover if it's a public header it is installed whereas the .cc is not.

3) Non API documentation, like documentation for executable usage
    like rtig, rtia etc... should be written in the .cc  file which contains
    the main(), this makes it easier to find.

4) If you need to add images in your doxygen comment you may
    use the \image doxygen markup using a png file.
    The image file itself should be put in certi/doc/images folder.

And last but not least, documentation only-patches are welcome :-)

-- 
Erk