doxygen/doxygen.m File Reference

Here comes a short description text. More...

Go to the source code of this file.

Functions
function rv =	doxygen ( param1, param2)
	Here comes a short description text.

---

Detailed Description

Here comes a short description text.

Definition in file doxygen.m.

---

Function Documentation

function rv = doxygen	(		param1,
			param2
	)

Here comes a short description text.

After the first empty documentation line, paragraphs of the detailed description begin.

Here, you have the following formatting possibilites

Adding LaTeX code in the text with

@f$ \sum_{n=0}^N \frac{1}{n} @f$ 

or as an equation block with

@f[ \sum_{n=0}^N \frac{1}{n}. @f] 

.

Doxygen commands always begin with an at-character(@) OR a backslash(\).

Words prepended by \c are written in a type-writer font. Words prepended by \b are written in a bold font. Words prepended by \em are written in an emphasized font.

Blocks starting with @verbatim or @code and are ended with @endverbatim or @endcode are written unformatted in a type-writer font and are not interpreted by doxygen.

Example

                    /| |\
                   ( |-| )
                    ) " (
                   (>(Y)<)
                    )   (
                   /     \
                  ( (m|m) )  hjw
                ,-.),___.(,-.\`97
                \`---\'   \`---\'
     

Paragaphs starting with line ending with a double-colon

are started with a bold title line

If you want to reference a function that is elsewhere documented append brackets and write

doxygen() 

in order to create a link for doxygen().

If, however, a double-colon at the end of a line is succeeded by: whitespace characters, like spaces or tabulators the line is not written in a bold font.

Note:

As regularly commands like

\c @f$, @f$ @f[, @f] 

look too distracting in matlab documentation output, the following shortcust exist: The doxygen filter translates

• 'word' to \c word 

  resulting in the output: word,

• `x` to @f$x@f$ 

  resulting in the output: and

• ``x`` to @f[x.@f] 

  resulting in the output:

  

  .

You therefore need to be careful with the use of characters

' `
     

. If you want to say something about the transposed of a Matrix A, better do it in a Tex-Environment as or in a verbatim/code environment as

 A' * B' 

Listings can be added by prepending lines with a dash(-)

• list 1 item which can also include newlines
• list 2 item
  • and they can be nested
  • subitem 2
• list 3 item

and they are ended by an empty documentation line.

Enumerations can be added by prepending lines with a dash and hash (-#)

1. first item
2. second item
3. third item

Lines beginning with the words "Parameters" or "Return values" start a block of argument respectively return argument descriptions.

A line beginning with the words "Required fields of", "optional fields of" or "generated fields of" start a block for descriptions for fields used by the parameters or generated for the return values.

Parameters:

param1	first parameter
param2	param2

Return values:

rv	return value

Required fields of param1:

• test —  Description for required field param1.test
• auto_added —  auto added
• sub.auto_added —  sub.auto added

Required fields of param2:

• auto_added —  auto added

Optional fields of param2:

• test2 —  Description for optional field param2.test2

Generated fields of rv:

• RB —  Description for generated field rv.RB
• auto_added —  auto added
• sub.auto_added —  sub.auto added

Comment blocks starting with %| are interpreted as Doxygen documentation blocks and can include doxygen commands like

Todo:

There needs to be done something in this file

Documentation Update:

Definition at line 1 of file doxygen.m.