blob: bb0af1c149199415a4244d2caedfaa06d847a4a6 [file] [log] [blame]
 %module doxygen_translate #if defined(SWIGJAVA) %javamethodmodifiers function "@Deprecated\npublic" #endif %inline %{ /** * \a Hello * * \arg some list item * * \authors lots of them * * \author Zubr * * \b boldword * * \c codeword * * \cite citationword * * \code some test code \endcode * * \cond SOMECONDITION * Some conditional comment * \endcond * * \copyright some copyright * * \deprecated Now use another function * * \e italicword * * \example someFile.txt * Some details on using the example * * \exception SuperError * * \if ANOTHERCONDITION * First part of comment * \if SECONDCONDITION * Nested condition text * \elseif THIRDCONDITION * The third condition text * \else * The last text block * \endif * \else * Second part of comment * \if CONDITION * Second part extended * \endif * \endif * * \ifnot SOMECONDITION * This is printed if not * \endif * * \image html testImage.bmp "Hello, world!" width=10cm * *
* * \li Some unordered list * \li With lots of items * \li lots of lots of items * *
* * \link someMember Some description follows \endlink * * \n \n \n * * \note Here * is the note! * * \overload * * \p someword * * \package superPackage * * \par The paragraph title * The paragraph text. * Maybe even multiline * * \param a the first param * * \remark Some remark text * * \remarks Another remarks section * * \result Whatever * * \return it * * \returns may return * * \sa someOtherMethod * * \see function * * \since version 0.0.0.1 * * \throw superException * * \throws RuntimeError * * \todo Some very important task * * \tparam b B is mentioned again... * * \verbatim * very long * text with tags * \endverbatim * * \version 0.0.0.2 * * \warning This is senseless! * * Here goes test of symbols: * \\$ \@ \\ \& \~ \< \> \# \% \" \. \:: * * And here goes simple text */ int function(int a, float b) { return 0; } /** * Test for html tags. See Doxygen doc for list of tags recognized by Doxygen. * * This is link * bold *
* Quotation block. *
*
*
center
* this is code * *
*
Starts an item title.
*
Starts an item description.
*
* * Starts a piece of text displayed in a typewriter font. * *
Starts a section with a specific style (HTML only) *
* Starts a piece of text displayed in an italic font. * *
'Form' does not generate any output. * *
*

*

*

* Starts a piece of text displayed in an italic font. * Input tag. * * Meta tag. * Multicol is ignored by doxygen. * * *
*
1. List item 1.
2. *
3. List item 2.
4. *
* *

Starts a new paragraph. *

*
Starts a preformatted fragment.
*
* Starts a section of text displayed in a smaller font. * * Starts an inline text fragment with a specific style. * Starts a section of bold text. * Starts a piece of text displayed in subscript. * Starts a piece of text displayed in superscript. * * *
Animals *
Column 1 Column 2
cow dog
cat mouse
horse parrot
* * * * * * Starts a piece of text displayed in a typewriter font. * * Starts a piece of text displayed in a typewriter font. * * *
*
• List item 1.
• *
• List item 2.
• *
• List item 3.
• *
* * Starts a piece of text displayed in an italic font. * * \htmlonly * underlined \b bold text - doxy commands are ignored inside 'htmlonly' section * \endhtmlonly */ void htmlFunction(int a, float b) { } /** * The meaning of flags: * * @param byFlags bits marking required items: * *
Size in bits Items Required
1 - 8 1
9 - 16 2
17 - 32 4
* * * * * Almost all combinations of above flags are supported by * \c htmlTable... functions. */ void htmlTableFunction(int byFlags) { } /** * All entities are treated as commands © ™ ® * should work also<in text * > * & * ' * " * ‘ * ’ * “ * ” * – * — *   * × * − * ⋅ * ∼ * ≤ * ≥ * ← * → * Not an &text; html entity - ignored by Doxygen. * Not an &text html entity - ampersand is replaced with entity. */ void htmlEntitiesFunction(int a, float b) { } %}