Examples and tutorials
The castle example
This example shows you how to
simply comment a file. Some variables/functions were commented,
some not, just to show you that Cod2Doc behaves fine in every cases.
You can access to the
commented code (sorry, Mark ;).
To show you differences between options, here are the resulting html pages with several settings:
Tutorial 1: a simple example
This example gives you the
basis to start with Cod2Doc.
Compare between the
source code and the
documentation produced with Cod2Doc.
Tutorial 2: a more complex example
This example will demonstrate
some additionnal abilities of Cod2Doc. In particular, you
will discover the usefulness of the inline documentation.
Compare between the
source code and the
documentation produced with Cod2Doc.
Tutorial 3: a simple example of .c2d file
This example shows how to use
.c2d files, which are files containing only
inline documentation. It is specially suited for
documenting libraries, creating help files like this one or even web pages.
Compare between the
c2d file and the
documentation produced with Cod2Doc.
on 09 Jul 2004.