249 lines
3.8 KiB
Python
Executable file
249 lines
3.8 KiB
Python
Executable file
#!/usr/bin/python
|
|
|
|
import doxygen_translate
|
|
import string
|
|
import sys
|
|
import commentVerifier
|
|
|
|
|
|
commentVerifier.check(doxygen_translate.function.__doc__,
|
|
r"""
|
|
_Hello_
|
|
|
|
-some list item
|
|
|
|
Authors: lots of them
|
|
|
|
Author: Zubr
|
|
|
|
__boldword__
|
|
|
|
'codeword'
|
|
|
|
'citationword'
|
|
|
|
some test code
|
|
|
|
Conditional comment: SOMECONDITION
|
|
Some conditional comment
|
|
End of conditional comment.
|
|
|
|
Copyright: some copyright
|
|
|
|
Deprecated: Now use another function
|
|
|
|
_italicword_
|
|
|
|
Example: someFile.txt
|
|
Some details on using the example
|
|
|
|
Throws: SuperError
|
|
|
|
If: ANOTHERCONDITION {
|
|
First part of comment
|
|
If: SECONDCONDITION {
|
|
Nested condition text
|
|
}Else if: THIRDCONDITION {
|
|
The third condition text
|
|
}Else: {The last text block
|
|
}
|
|
}Else: {Second part of comment
|
|
If: CONDITION {
|
|
Second part extended
|
|
}
|
|
}
|
|
|
|
If not: SOMECONDITION {
|
|
This is printed if not
|
|
}
|
|
|
|
Image: testImage.bmp("Hello, world!")
|
|
|
|
|
|
|
|
-Some unordered list
|
|
-With lots of items
|
|
-lots of lots of items
|
|
|
|
|
|
|
|
someMember Some description follows
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Notes: Here
|
|
is the note!
|
|
|
|
This is an overloaded member function, provided for convenience.
|
|
It differs from the above function only in what argument(s) it accepts.
|
|
|
|
someword
|
|
|
|
|
|
|
|
Title: The paragraph title
|
|
The paragraph text.
|
|
Maybe even multiline
|
|
|
|
Arguments:
|
|
a (int) -- the first param
|
|
|
|
Remarks: Some remark text
|
|
|
|
Another remarks section
|
|
|
|
Return: Whatever
|
|
|
|
it
|
|
|
|
Returns: may return
|
|
|
|
See also: someOtherMethod
|
|
|
|
See also: function
|
|
|
|
Since: version 0.0.0.1
|
|
|
|
Throw: superException
|
|
|
|
Throws: RuntimeError
|
|
|
|
TODO: Some very important task
|
|
|
|
Arguments:
|
|
b (float) -- B is mentioned again...
|
|
|
|
|
|
very long
|
|
text with tags <sometag>
|
|
|
|
|
|
Version: 0.0.0.2
|
|
|
|
Warning: This is senseless!
|
|
|
|
Here goes test of symbols:
|
|
$ @ \ & ~ < > # % " . ::
|
|
|
|
And here goes simple text
|
|
"""
|
|
)
|
|
|
|
|
|
|
|
commentVerifier.check(doxygen_translate.htmlFunction.__doc__,
|
|
r"""
|
|
Test for html tags. See Doxygen doc for list of tags recognized by Doxygen.
|
|
|
|
This is link ("http://acme.com/index.html")
|
|
__bold__
|
|
Quote:
|
|
Quotation block.
|
|
("http://www.worldwildlife.org/who/index.html")
|
|
|
|
|
|
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.
|
|
|
|
--------------------------------------------------------------------
|
|
|
|
# Heading 1
|
|
|
|
## Heading 2
|
|
|
|
### Heading 3
|
|
|
|
_Starts a piece of text displayed in an italic font._
|
|
Input tag.
|
|
Image: src="slika.png"
|
|
Meta tag.
|
|
Multicol is ignored by doxygen.
|
|
|
|
|
|
|
|
- List item 1.
|
|
- List item 2.
|
|
|
|
|
|
|
|
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._
|
|
|
|
|
|
<u>underlined \b bold text - doxy commands are ignored inside 'htmlonly' section </u>
|
|
|
|
""")
|
|
|
|
|
|
commentVerifier.check(doxygen_translate.htmlEntitiesFunction.__doc__,
|
|
r"""
|
|
All entities are treated as commands (C) TM (R)
|
|
should work also<in text
|
|
>
|
|
&
|
|
'
|
|
"
|
|
`
|
|
'
|
|
"
|
|
"
|
|
-
|
|
--
|
|
|
|
x
|
|
-
|
|
.
|
|
~
|
|
<=
|
|
>=
|
|
<--
|
|
-->
|
|
Not an html entity - ignored by Doxygen.
|
|
Not an &text html entity - ampersand is replaced with entity.
|
|
""")
|