The .c2d files are files containing
only inline documentation.
Refer to the example file
MoreComplexExample.html to see more details on what
you can insert in inline documentation.
The help files of Cod2Doc have been created using
exclusively .c2d files! The
web page was also created with Cod2Doc!!
But here I would like to demonstrate that .c2d files are perfect to document a library where
you want to document functions and variables in an order that is not the one from the .bb
program.
For that, you have still to comment your functions/variables in the .bb code (which helps you
to maintain a clean code!).
So let's start for a very basic example, using the functions/variables defined in the
SimpleExample.bb
file.
A very useful library
This is some text which will be placed before the description of my first variable (here
a type).
|
aType |
Description:
Here you put the description of the type
with as many lines as you want
|
Field description:
field1 = Description of this field
field2 = Description of the second field
with several lines of description with the ;+ tag
and an attached lines with the ;;+ tag
|
Here some text again with a list:
And now let's include the function aFunction:
|
aFunction(var1%,var2$,[var3#=1.]) |
Description:
Put here the description of the function
The description of argument is done like this:
|
Parameters:
var1% = here is the description of this variable
var2$ = here is the description
with the possibility to add more lines with the ;+ tag
and with an attached line here with the ;;+ tag
var3# = another description [Default value = 1.]
|
Return value:
the description of the return value
|
That's it for this example, hoping it will give you a lot of good ideas!!
on 26 Jan 2004.