Use reST inline markup in PyDocConverter instead of Markdown.

reST is standard Python markup, so use *...*, ``...`` and so on instead of
_..._, '...' etc.

No other changes even though the mapping of some Doxygen tags to markup used
for them seems suspicions (e.g. \var almost certainly should be the same as
\em).
This commit is contained in:
Vadim Zeitlin 2014-06-16 00:01:36 +02:00
commit 7d2743a0bb
5 changed files with 60 additions and 60 deletions

View file

@ -30,13 +30,13 @@ commentVerifier.check(doxygen_basic_translate.function3.__doc__,
Overload 1:
----------------------------------------------------------------
A test for overloaded functions
This is function __one__
This is function **one**
----------------------------------------------------------------
Overload 2:
----------------------------------------------------------------
A test for overloaded functions
This is function __two__
This is function **two**
"""
)
@ -44,11 +44,11 @@ commentVerifier.check(doxygen_basic_translate.function4.__doc__,
"""
A test of some mixed tag usage
If: CONDITION {
This _code_ fragment shows us something .
This *code* fragment shows us something .
Title: Minuses:
-it\'s senseless
-it\'s stupid
-it\'s null
* it\'s senseless
* it\'s stupid
* it\'s null
Warning: This may not work as expected

View file

@ -41,8 +41,8 @@ commentVerifier.check(doxygen_misc_constructs.CConnectionConfig.__doc__,
commentVerifier.check(doxygen_misc_constructs.waitTime.__doc__,
r"""
Determines how long the 'isystem.connect' should wait for running
instances to respond. Only one of 'lfWaitXXX' flags from IConnect::ELaunchFlags
Determines how long the ``isystem.connect`` should wait for running
instances to respond. Only one of ``lfWaitXXX`` flags from IConnect::ELaunchFlags
may be specified.
"""
)
@ -84,7 +84,7 @@ commentVerifier.check(doxygen_misc_constructs.isNoSpaceValidC.__doc__,
commentVerifier.check(doxygen_misc_constructs.backslashA.__doc__,
r"""
Backslash following'word' is a valid doxygen command. Output contains
Backslash following``word`` is a valid doxygen command. Output contains
'followingword' with 'word' in code font.
"""
)
@ -108,8 +108,8 @@ commentVerifier.check(doxygen_misc_constructs.backslashB.__doc__,
commentVerifier.check(doxygen_misc_constructs.backslashC.__doc__,
r"""
Backslash e at end of _line_ froze SWIG
_with_ old comment parser.
Backslash e at end of *line* froze SWIG
*with* old comment parser.
See also: MyClass::fun(char,
float)
@ -124,9 +124,9 @@ commentVerifier.check(doxygen_misc_constructs.cycle.__doc__,
['retVal < 10', 'g_counter == 23 && g_mode & 3']
Both words should be emphasized __isystem.connect__.
But not the last period. For __example__, comma should not be emphasized.
Similar __for__: double colon.
Both words should be emphasized **isystem.connect**.
But not the last period. For **example**, comma should not be emphasized.
Similar **for**: double colon.
Spaces at the start of line should be taken into account:
:type id: int
@ -136,7 +136,7 @@ commentVerifier.check(doxygen_misc_constructs.cycle.__doc__,
ctrl.setBP("func1");
If we set the id to 'main_', we get:
If we set the id to ``main_``, we get:
main_ctrl.setBP("func1");

View file

@ -8,13 +8,13 @@ import commentVerifier
commentVerifier.check(doxygen_translate_all_tags.func01.__doc__,
r"""
_Hello_
*Hello*
-some list item
* some list item
This is attention!
You were warned!
@ -22,13 +22,13 @@ r"""
Authors: lots of them
Author: Zubr
__boldword__
**boldword**
Some brief description,
extended to many lines.
Not everything works right now...
'codeword'
``codeword``
@ -67,7 +67,7 @@ r"""
commentVerifier.check(doxygen_translate_all_tags.func03.__doc__,
r"""
Comment for __func03()__.
Comment for **func03()**.
@ -77,7 +77,7 @@ r"""
_italicword_
*italicword*
emphazedWord
@ -155,7 +155,7 @@ r"""
commentVerifier.check(doxygen_translate_all_tags.func06.__doc__,
r"""
Comment for __func06()__.
Comment for **func06()**.
@ -165,9 +165,9 @@ r"""
-Some unordered list
-With lots of items
-lots of lots of items
* Some unordered list
* With lots of items
* lots of lots of items
@ -194,7 +194,7 @@ r"""
commentVerifier.check(doxygen_translate_all_tags.func07.__doc__,
r"""
Comment for __func07()__.
Comment for **func07()**.

View file

@ -8,17 +8,17 @@ import commentVerifier
commentVerifier.check(doxygen_translate.function.__doc__,
r"""
_Hello_
*Hello*
-some list item
* some list item
Authors: lots of them
Author: Zubr
__boldword__
**boldword**
'codeword'
``codeword``
'citationword'
@ -32,7 +32,7 @@ r"""
Deprecated: Now use another function
_italicword_
*italicword*
Example: someFile.txt
Some details on using the example
@ -61,9 +61,9 @@ r"""
-Some unordered list
-With lots of items
-lots of lots of items
* Some unordered list
* With lots of items
* lots of lots of items
@ -139,14 +139,14 @@ 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:
**bold**
Quote:
Quotation block.
("http://www.worldwildlife.org/who/index.html")
center
'this is code'
``this is code``
Starts an item title.
@ -157,7 +157,7 @@ r"""
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.
@ -169,7 +169,7 @@ r"""
### Heading 3
_Starts a piece of text displayed in an italic font._
*Starts a piece of text displayed in an italic font.*
Input tag.
Image: src="slika.png"
Meta tag.
@ -177,8 +177,8 @@ r"""
- List item 1.
- List item 2.
* List item 1.
* List item 2.
@ -189,7 +189,7 @@ r"""
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 section of bold text.**
Starts a piece of text displayed in subscript.
Starts a piece of text displayed in superscript.
@ -208,12 +208,12 @@ r"""
- 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>
@ -235,7 +235,7 @@ r"""
| 17 - 32 | 4 |
Almost all combinations of above flags are supported by
'htmlTable...' functions.
``htmlTable...`` functions.
""")