root/branches/newmole/doxygen/doxygen_setup_style.txt

Revision 688, 2.7 kB (checked in by peter, 2 years ago)

Merge changes from mainline upto r685 (second installment).

Mop up a few remaining issues.

  • Property svn:eol-style set to native
Line 
1to change options in setup file (Doxyfile) do
2doxywizard Doxyfile
3mode - optimize for C output
4
5expert tab has many options
6
7to run doxygen and create output do
8doxygen Doxyfile
9in this directory
10
11check whether INPUT parameter in Doxyfile is set to source_hot or source - this changes
12source is the archived version and source_hot is the local development version
13
14to generate the ouput doxygen also needs graphviz, another open source app.  graphviz needs
15to be on the path for doxygen to find it.
16
17Doxyfile is set up to create only html output.  other options are possible.  The html will be
18in the html directory below this main directory.
19
20Within the codebase, doxygen markup is fully contained in the headers.  All doxygen special comment blocks are using the "C style" markup.  Special comment blocks are indicated by /**.  Commands are indicated with the with the syntax \command.  All comment blocks are immediately before what they describe, with the exception of some struct members, where the comment immediately follows ("/**<" syntax).  Within special commente blocks, the \, @, &, $, #, <, >, % characters must be escaped using a preceeding \
21
22The following commands are in use:
23\file <filename> (description)  - description for a file, will appear in the output above any descriptions of items contained in the file.
24\verbatim  - Doxygen outputs text enclosed in verbatim/endverbatim tags exactly (ie, preserving whitespace and newlines)
25\endverbatim
26\param [in|out|in,out] <parameter name> (description) - describe a parameter of a function.  Parameter name is the name of the variable and does not include type.  [in|out|in,out] is optional.
27\post (description) - describe the post conditions for a function
28\return (description) - describe what the function returns (in output "Returns "+description is printed)
29\author Joe Blow
30
31latex in line
32\f$ - same as in line $  - opposite is another \f$
33
34The ideal declaration should look like the following:
35=======================================================
36
37 /**
38  routine_name This is the long description of what routine_name does, appears after
39        the function name
40  \brief this is routine brief description - only 1 line long
41  \param iz  a description of what parameter 1 is for
42  \param [in] in  a description of what parameter 2 is for
43  \param [out] *out description
44  \author Joe Blow
45  \return explain the return value
46 */
47double routine_name(long int iz,
48  long int in ,
49  double *out );
50
51=======================================================
52
53The manual for doxygen can be found: http://www.stack.nl/~dimitri/doxygen/download.html#latestman
54The full description of these commands and all others are under "Special Commands" in the "Reference Manual" section.
Note: See TracBrowser for help on using the browser.