1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
|
%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
*
* <ul>
*
* \li Some unordered list
* \li With lots of items
* \li lots of lots of items
*
* </ul>
*
* \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 <sometag>
* \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.
*
* <a href="http://acme.com/index.html">This is link</a>
* <b>bold</b>
* <BLOCKQUOTE cite="http://www.worldwildlife.org/who/index.html">
* Quotation block.
* </BLOCKQUOTE>
* <br>
* <center>center</center>
* <code>this is code</code>
*
* <DL>
* <DT>Starts an item title.</DT>
* <DD>Starts an item description.</dd>
* </dl>
*
* <DFN>Starts a piece of text displayed in a typewriter font.
* </DFN>
* <DIV>Starts a section with a specific style (HTML only)
* </DIV>
* <EM>Starts a piece of text displayed in an italic font.</EM>
*
* <FORM>'Form' does not generate any output.
* </FORM>
* <HR>
* <H1>Heading 1
* </H1>
* <H2>Heading 2
* </H2>
* <H3>Heading 3
* </H3>
* <I>Starts a piece of text displayed in an italic font.</I>
* <INPUT>Input tag.
* <IMG src="slika.png">
* <META>Meta tag.
* <MULTICOL>Multicol is ignored by doxygen.
* </MULTICOL>
*
* <OL>
* <LI>List item 1.</LI>
* <LI>List item 2.</LI>
* </OL>
*
* <P>Starts a new paragraph.
* </P>
* <PRE>Starts a preformatted fragment.
* </PRE>
* <SMALL>Starts a section of text displayed in a smaller font.
* </SMALL>
* <SPAN>Starts an inline text fragment with a specific style.</SPAN>
* <STRONG>Starts a section of bold text.</STRONG>
* <SUB>Starts a piece of text displayed in subscript.</SUB>
* <SUP>Starts a piece of text displayed in superscript.</SUP>
*
* <table border = '1'>
* <caption>Animals</caption>
* <tr><th> Column 1 </th><th> Column 2 </th></tr>
* <tr><td> cow </td><td> dog </td></tr>
* <tr><td> cat </td><td> mouse </td></tr>
* <tr><td> horse </td><td> parrot </td></tr>
* </table>
*
* <TT>Starts a piece of text displayed in a typewriter font.
* </TT>
* <KBD>Starts a piece of text displayed in a typewriter font.
* </KBD>
*
* <UL>
* <LI>List item 1.</LI>
* <LI>List item 2.</LI>
* <LI>List item 3.</LI>
* </UL>
*
* <VAR>Starts a piece of text displayed in an italic font.</VAR>
*
* \htmlonly
* <u>underlined \b bold text - doxy commands are ignored inside 'htmlonly' section </u>
* \endhtmlonly
*/
void htmlFunction(int a, float b)
{
}
/**
* The meaning of flags:
*
* @param byFlags bits marking required items:
* <table>
* <tr><th> Size in bits</th><th> Items Required </th></tr>
* <tr><td> 1 - 8 </td><td> 1 </td></tr>
* <tr><td> 9 - 16 </td><td> 2 </td></tr>
* <tr><td> 17 - 32 </td><td> 4 </td></tr>
* </table>
* 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)
{
}
%}
|