[Omms-devel] documentation

[Florian B. <Flo...@gm...>]

Hi

I documented most functions in omms.h in JavaDoc style. U can type
'make doc' in the root directory to have doxygen generate html documentation
which will go into ./doc/html then. I used the /** syntax so that it should be
possible to use doc++ as well. Has anyone experience with one/both systems and
knows which one is better? 

As mentioned above most functions and classes are documented, more may follow
later. I didn't document the MemXX classes (yet). They are usable child classes
of the abstract interfaces and organize their data in memory. 

Functions which IMO don't make up a good interface are NOT documented. So if you
find an undocumented function/method whatever, please doublecheck if they are a
candidate of being removed again before using it. I put some comments beside
these functions.

-Flo

-- 
mailto: Florian Braun <Flo...@gm...>
pgp-key available at: 
http://rupert.informatik.uni-stuttgart.de/~braunfn/pgpkey.txt