1 function rv =
doxygen(param1, param2)
2 %
function rv =
doxygen(param1, param2) is ignored
3 % Here comes a
short description text
5 % After the first empty documentation line, paragraphs of the detailed
8 % Here, you have the following formatting possibilites:
9 % Adding LaTeX code in the text with \verbatim @f$ \sum_{n=0}^N \frac{1}{n} @f$ \endverbatim
10 % @f$ \sum_{n=0}^N \frac{1}{n} @f$ or as an
11 % equation block with @verbatim @f[ \sum_{n=0}^N \frac{1}{n}. @f]
@endverbatim.
12 % @f[ \sum_{n=0}^N \frac{1}{n}. @f] Doxygen commands
13 % always begin with an at-character(\@) OR a backslash(\\).
15 % Words prepended by \\c are written in a \c type-writer font.
16 % Words prepended by \\b are written in a \b bold font.
17 % Words prepended by \\em are written in an \em emphasized font.
19 % Blocks starting with @@verbatim or @@code and are ended with @@endverbatim or
20 % @@endcode are written unformatted in a type-writer font and are not
36 % Paragaphs starting with line ending with a
double-colon:
37 % are started with a bold title line
39 % If you want to reference a function that is elsewhere documented append
40 % brackets and write @verbatim
doxygen() @endverbatim in order to create a link
43 % If, however, a double-colon at the end of a line is succeeded by:
44 % whitespace characters, like spaces or tabulators the line is not written in a
47 % @note As regularly commands like @verbatim \c @f$, @f$ @f[, @f] @endverbatim
48 % look too distracting in matlab documentation output, the following shortcust
49 % exist: The doxygen filter translates
50 % - @verbatim 'word' to \c word @endverbatim resulting in the output: 'word',
51 % - @verbatim `x` to @f$x@f$ @endverbatim resulting in the output: `x` and
52 % - @verbatim ``x`` to @f[x.@f] @endverbatim resulting in the output: ``x``.
54 % You therefore need to be careful with the use of characters @verbatim ' `
55 % @endverbatim. If you want to say something about the transposed of a Matrix
56 % 'A', better do it in a Tex-Environment as `A' * B'` or in a verbatim/code
58 % @code A' * B' @endcode
60 % Listings can be added by prepending lines with a dash(-)
61 % - list 1 item which can also include
64 % - and they can be nested
69 % and they are ended by an empty documentation line.
71 % Enumerations can be added by prepending lines with a dash and hash (-#)
76 % Lines beginning with the words "Parameters" or "Return values" start a block
77 % of argument respectively return argument descriptions.
80 % param1: first parameter
85 % A line beginning with the words "Required fields of", "optional fields of" or
86 % "generated fields of" start a block for descriptions for fields used by the
87 % parameters or generated for the return values.
89 % Required fields of param1:
90 % test: Description for required field param1.test
92 % Optional fields of param2:
93 % test2: Description for optional field param2.test2
95 % Generated fields of rv:
96 % RB: Description for generated field rv.RB
100 % After the first non-comment line the function body begins:
102 %| Comment blocks starting with %| are interpreted as Doxygen documentation
103 % blocks and can include doxygen commands like
105 %| \todo There needs to be done something in this file
107 % fields of parameters that are used in the function body are added to the
108 % required fileds list automatically, if they are not documentated yet.
113 % fields of
return values that are assigned somewhere in the
function body are
114 % also added automatically to the list of generated fields
116 rv.sub.auto_added = 2;
118 param1.sub.auto_added;
function rv = doxygen(param1, param2)
Here comes a short description text.