[ESPResSo-devel] Documentation

[Olaf Lenz]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hello!

Originally I wanted to wait until the first round of proof-reading is
done, but as it seems to take some time, I think it is necessary to
officially announce the User's Guide:
Since a few months, the documentation is split into two documentation
parts, the User's Guide (UG), and the Developer's Guide (DG).

The UG is written in LaTeX and should contain the documentation for all
Tcl commands and describe the algorithms behind ES, or at least give
references to the algorithms.  In the current state, the UG consists
mostly of the relevant documentation copied from the old doxygen
documentation. The DG is basically the old doxygen documentation WITHOUT
the stuff that went into the UG.

For you, this just means, that when implement or modify a Tcl command,
please document it in the UG instead of in the doxygen documentation! To
learn how to do this correctly, have a look at the page "Writing the
User's Guide" in the Developer's Guide, e.g.

        http://espressowiki.mpip-mainz.mpg.de/espresso/dg/html/ug.html

In the rare case that you should want to document anything on the
implementation of the code, please do so in the DG, i.e. use doxygen. It
is NOT necessary to document the same thing in two places, one should be
sufficient.

Best regards
        Olaf
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.1 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org

iD8DBQFG1B54tQ3riQ3oo/oRAp4tAJ0WwK6aDqBZp5FvtmDdzG8wv6trJgCeOqjT
fOStG3FHxRG2kAceU4w/YxY=
=vO+p
-----END PGP SIGNATURE-----