[Main page] [Overview]     /concepts /autodoc

---

CONCEPT
autodoc

DESCRIPTION
The autodoc daemon generates documentation about the lib code.
This task is launched once every day, and only checks the new files.
The daemon recognizes the following 'commands' withing the source
code:

//:MODULE
// Your comments ...

//:FUNCTION fun_name
// Function description

//:FUNCTION fun_name( arguments);
// Function description

//:STRUCT struct_name
// Struct description

You can write them where you want in the lib file, but they
MUST be written at the beginning of the line (don't leave
blank spaces). 'fun_name' and 'com_name' are NOT optional.
Be carefull with your comments in the code. If you write some
of them just behind any of the above 'commands', it will be
understood as part of the documentation, and don't leave any
blank line between the same 'command'.

Don't do this:
//:Module <--- Commands must be in Uppercase

//This module is used to ... <--- That line is not recognized,
because there's an empty
line above it.

The autodoc creates the following directory tree:

/doc/basic/
/doc/daemon/
/doc/module
/doc/sefun/
/doc/std/
/doc/struct/

EXAMPLES
Just look into some lib files for examples.