Merge latest master into doxygen branch again.
Update Doxygen-specific Python unit tests to work with the new indentation. Update one of Doxygen-specific Java tests to still build with the new handling of srcdir.
This commit is contained in:
commit
6cce652762
557 changed files with 4998 additions and 4138 deletions
302
Examples/test-suite/python/doxygen_translate_runme.py
Executable file → Normal file
302
Examples/test-suite/python/doxygen_translate_runme.py
Executable file → Normal file
|
|
@ -8,260 +8,260 @@ import commentVerifier
|
|||
|
||||
commentVerifier.check(doxygen_translate.function.__doc__,
|
||||
r"""
|
||||
_Hello_
|
||||
_Hello_
|
||||
|
||||
-some list item
|
||||
-some list item
|
||||
|
||||
Authors: lots of them
|
||||
Authors: lots of them
|
||||
|
||||
Author: Zubr
|
||||
Author: Zubr
|
||||
|
||||
__boldword__
|
||||
__boldword__
|
||||
|
||||
'codeword'
|
||||
'codeword'
|
||||
|
||||
'citationword'
|
||||
'citationword'
|
||||
|
||||
some test code
|
||||
some test code
|
||||
|
||||
Conditional comment: SOMECONDITION
|
||||
Some conditional comment
|
||||
End of conditional comment.
|
||||
Conditional comment: SOMECONDITION
|
||||
Some conditional comment
|
||||
End of conditional comment.
|
||||
|
||||
Copyright: some copyright
|
||||
Copyright: some copyright
|
||||
|
||||
Deprecated: Now use another function
|
||||
Deprecated: Now use another function
|
||||
|
||||
_italicword_
|
||||
_italicword_
|
||||
|
||||
Example: someFile.txt
|
||||
Some details on using the example
|
||||
Example: someFile.txt
|
||||
Some details on using the example
|
||||
|
||||
Throws: SuperError
|
||||
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
|
||||
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
|
||||
}
|
||||
}
|
||||
}Else: { Second part of comment
|
||||
If: CONDITION {
|
||||
Second part extended
|
||||
|
||||
If not: SOMECONDITION {
|
||||
This is printed if not
|
||||
}
|
||||
}
|
||||
|
||||
If not: SOMECONDITION {
|
||||
This is printed if not
|
||||
}
|
||||
|
||||
Image: testImage.bmp("Hello, world!")
|
||||
Image: testImage.bmp("Hello, world!")
|
||||
|
||||
|
||||
|
||||
-Some unordered list
|
||||
-With lots of items
|
||||
-lots of lots of items
|
||||
-Some unordered list
|
||||
-With lots of items
|
||||
-lots of lots of items
|
||||
|
||||
|
||||
|
||||
someMember Some description follows
|
||||
someMember Some description follows
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Notes: Here
|
||||
is the note!
|
||||
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.
|
||||
This is an overloaded member function, provided for convenience.
|
||||
It differs from the above function only in what argument(s) it accepts.
|
||||
|
||||
someword
|
||||
someword
|
||||
|
||||
|
||||
|
||||
Title: The paragraph title
|
||||
The paragraph text.
|
||||
Maybe even multiline
|
||||
Title: The paragraph title
|
||||
The paragraph text.
|
||||
Maybe even multiline
|
||||
|
||||
Arguments:
|
||||
a (int) -- the first param
|
||||
Arguments:
|
||||
a (int) -- the first param
|
||||
|
||||
Remarks: Some remark text
|
||||
Remarks: Some remark text
|
||||
|
||||
Another remarks section
|
||||
Another remarks section
|
||||
|
||||
Return: Whatever
|
||||
Return: Whatever
|
||||
|
||||
it
|
||||
it
|
||||
|
||||
Returns: may return
|
||||
Returns: may return
|
||||
|
||||
See also: someOtherMethod
|
||||
See also: someOtherMethod
|
||||
|
||||
See also: function
|
||||
See also: function
|
||||
|
||||
Since: version 0.0.0.1
|
||||
Since: version 0.0.0.1
|
||||
|
||||
Throw: superException
|
||||
Throw: superException
|
||||
|
||||
Throws: RuntimeError
|
||||
Throws: RuntimeError
|
||||
|
||||
TODO: Some very important task
|
||||
TODO: Some very important task
|
||||
|
||||
Arguments:
|
||||
b (float) -- B is mentioned again...
|
||||
Arguments:
|
||||
b (float) -- B is mentioned again...
|
||||
|
||||
|
||||
very long
|
||||
text with tags <sometag>
|
||||
very long
|
||||
text with tags <sometag>
|
||||
|
||||
|
||||
Version: 0.0.0.2
|
||||
Version: 0.0.0.2
|
||||
|
||||
Warning: This is senseless!
|
||||
Warning: This is senseless!
|
||||
|
||||
Here goes test of symbols:
|
||||
$ @ \ & ~ < > # % " . ::
|
||||
Here goes test of symbols:
|
||||
$ @ \ & ~ < > # % " . ::
|
||||
|
||||
And here goes simple text
|
||||
"""
|
||||
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.
|
||||
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")
|
||||
This is link ("http://acme.com/index.html")
|
||||
__bold__
|
||||
Quote:
|
||||
Quotation block.
|
||||
("http://www.worldwildlife.org/who/index.html")
|
||||
|
||||
|
||||
center
|
||||
'this is code'
|
||||
center
|
||||
'this is code'
|
||||
|
||||
|
||||
Starts an item title.
|
||||
Starts an item description.
|
||||
Starts an item title.
|
||||
Starts an item description.
|
||||
|
||||
|
||||
Starts a piece of text displayed in a typewriter font.
|
||||
Starts a piece of text displayed in a typewriter font.
|
||||
|
||||
Starts a section with a specific style (HTML only)
|
||||
Starts a section with a specific style (HTML only)
|
||||
|
||||
__Starts a piece of text displayed in an italic font.__
|
||||
__Starts a piece of text displayed in an italic font.__
|
||||
|
||||
'Form' does not generate any output.
|
||||
'Form' does not generate any output.
|
||||
|
||||
--------------------------------------------------------------------
|
||||
--------------------------------------------------------------------
|
||||
|
||||
# Heading 1
|
||||
# Heading 1
|
||||
|
||||
## Heading 2
|
||||
## Heading 2
|
||||
|
||||
### Heading 3
|
||||
### 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.
|
||||
_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.
|
||||
- List item 1.
|
||||
- List item 2.
|
||||
|
||||
|
||||
|
||||
Starts a new paragraph.
|
||||
Starts a new paragraph.
|
||||
|
||||
Starts a preformatted fragment.
|
||||
Starts a preformatted fragment.
|
||||
|
||||
Starts a section of text displayed in a smaller font.
|
||||
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.
|
||||
'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 |
|
||||
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.
|
||||
|
||||
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.
|
||||
- List item 1.
|
||||
- List item 2.
|
||||
- List item 3.
|
||||
|
||||
|
||||
_Starts a piece of text displayed in an italic font._
|
||||
_Starts a piece of text displayed in an italic font._
|
||||
|
||||
|
||||
<u>underlined \b bold text - doxy commands are ignored inside 'htmlonly' section </u>
|
||||
<u>underlined \b bold text - doxy commands are ignored inside 'htmlonly' section </u>
|
||||
|
||||
""")
|
||||
""")
|
||||
|
||||
|
||||
commentVerifier.check(doxygen_translate.htmlTableFunction.__doc__,
|
||||
r"""
|
||||
The meaning of flags:
|
||||
The meaning of flags:
|
||||
|
||||
Arguments:
|
||||
byFlags (int) -- 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
|
||||
'htmlTable...' functions.
|
||||
""")
|
||||
Arguments:
|
||||
byFlags (int) -- 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
|
||||
'htmlTable...' functions.
|
||||
""")
|
||||
|
||||
|
||||
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.
|
||||
""")
|
||||
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.
|
||||
""")
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue