X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=web%2Fmanual.m4;fp=web%2Fmanual.m4;h=59abc5385f9eb5cdcc4a21bfbdb6a30567fa6b90;hp=88e31169325daae526a09087b834e9bc5a3646a3;hb=db748cc3c4d60e1ec7fefe2ad58142c2820ae07f;hpb=2dddc3b31a08751f50a6ddfc0144c08b67bed314;ds=sidebyside diff --git a/web/manual.m4 b/web/manual.m4 index 88e31169..59abc538 100644 --- a/web/manual.m4 +++ b/web/manual.m4 @@ -2011,21 +2011,19 @@ Doxygen ~~~~~~~ Doxygen is a documentation system for various programming -languages. The paraslash project uses Doxygen for generating the API -reference on the web pages, but good source code documentation is -also beneficial to people trying to understand the code structure -and the interactions between the various source files. +languages. The API reference on the paraslash web page is generated +by doxygen. It is more illustrative to look at the source code for examples than -to describe the conventions for documenting the source in this manual, -so we only describe which parts of the code need doxygen comments, -but leave out details on documentation conventions. +to describe the conventions in this manual, so we only describe which +parts of the code need doxygen comments, but leave out details on +documentation conventions. As a rule, only the public part of the C source is documented with Doxygen. This includes structures, defines and enumerations in header files as well as public (non-static) C functions. These should be -documented completely. For example each parameter and the return -value of a public function should get a descriptive comment. +documented completely. For example, each parameter and the return +value of a public function should get a descriptive doxygen comment. No doxygen comments are necessary for static functions and for structures and enumerations in C files (which are used only within