swig/Examples/test-suite/doxygen_translate.i
2013-01-18 21:21:12 +01:00

214 lines
4.3 KiB
OpenEdge ABL

%module doxygen_translate
%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!" asd=10qwe
*
* <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)
{
}
/**
* 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>
* Quotation block.
* </BLOCKQUOTE>
* <br>
* <center>center</center>
* <code>this is code</code>
* <DD> Starts an item description.
* <DFN> Starts a piece of text displayed in a typewriter font.
* </DFN>
* <DIV> Starts a section with a specific style (HTML only)
* </DIV>
* <DL> Starts a description list.
* <DT> Starts an item title.</DT>
* </DL>
* <EM> Starts a piece of text displayed in an italic font.
* </EM>
* <FORM> 'Form' does not generate any output.
* </FORM>
* <HR>
* <H1> Starts an unnumbered section.
* </H1>
* <H2> Starts an unnumbered subsection.
* </H2>
* <H3> Starts an unnumbered subsubsection.
* </H3>
* <I> Starts a piece of text displayed in an italic font.
* <INPUT> Does not generate any output.
* </I>
* <IMG src="slika.png">
* <META> Does not generate any output.
* <MULTICOL> ignored by doxygen.
* </MULTICOL> ignored by doxygen.
*
* <OL> Starts a numbered item list.
* <LI> Starts a new list item.
* </LI>
* </OL> Ends a numbered item list.
*
* <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 (HTML only)
* </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> cow </th><th> dog </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> Starts an unnumbered item list.
* <LI> Starts a new list item 1.</LI>
* <LI> Starts a new list item 2.</LI>
* <LI> Starts a new list item 3.</LI>
* </UL> Ends an unnumbered item list.
*
* <VAR> Starts a piece of text displayed in an italic font.
* </VAR>
*/
int htmlFunction(int a, float b)
{
}
%}