X-Git-Url: http://git.tuebingen.mpg.de/?a=blobdiff_plain;f=web%2Fmanual.m4;h=d63b07e8cbb69067439db6bca4875f9867908831;hb=6fbd93c8420823356a24a3637d332c23c0c85dcd;hp=8c00c99bb3ef884ff46ba1c8ba9a3d3cfa87e1e7;hpb=fdb03951ee708a42795d4abb36d3a8637c478975;p=paraslash.git diff --git a/web/manual.m4 b/web/manual.m4 index 8c00c99b..d63b07e8 100644 --- a/web/manual.m4 +++ b/web/manual.m4 @@ -259,7 +259,8 @@ Optional: - XREFERENCE(http://www.underbit.com/products/mad/, libid3tag). For version-2 ID3 tag support, you'll need the libid3tag development package libid3tag0-dev. Without - libid3tag, only version one tags are recognized. + libid3tag, only version-1 tags are recognized. The mp3 tagger + also needs this library for modifying (id3v1 and id3v2) tags. - XREFERENCE(http://www.xiph.org/downloads/, ogg vorbis). For ogg vorbis streams you'll need libogg, libvorbis, @@ -2009,21 +2010,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