X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=web%2Fmanual.m4;h=addc24589b9fb5958273b54d6542edce1c2615b8;hp=0963306e226bf3bdbd7e03ba591a8cfc970c2946;hb=4ad8a5536d7cea1e63137933b242c52e57bd53d6;hpb=0f4910b50116416fefb09ca67a615679067ef359 diff --git a/web/manual.m4 b/web/manual.m4 index 0963306e..addc2458 100644 --- a/web/manual.m4 +++ b/web/manual.m4 @@ -208,7 +208,7 @@ For the impatient: cd osl && make && sudo make install && sudo ldconfig sudo apt-get install autoconf libssl-dev help2man gengetopt \ libmad0-dev libid3tag0-dev libasound2-dev libvorbis-dev \ - libfaad-dev libspeex-dev libFLAC-dev libsamplerate-dev \ + libfaad-dev libspeex-dev libFLAC-dev libsamplerate-dev realpath \ libasound2-dev libao-dev libreadline-dev libncurses-dev \ libopus-dev @@ -956,12 +956,13 @@ is not set, the empty string is matched against the pattern. frequency ~ channels ~ num_played ~ + image_id ~ + lyrics_id ~ Takes a comparator ~ of the set {<, =, <=, >, >=, !=} and a number . Matches an audio file iff the condition ~ is satisfied where val is the corresponding value of the audio file -(value of the year tag, bitrate in kbit/s, frequency in Hz, channel -count, play count). +(value of the year tag, bitrate in kbit/s, etc.). The year tag is special as its value is undefined if the audio file has no year tag or the content of the year tag is not a number. Such @@ -2010,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