Merge branch 'doxy/commands'
* doxy/commands: Update documentation for doxygen tags Fix doxygen translation of \p command for python Fix doxygen handling of \em tag for python Minor formatting updates to doxygen docs Reformat tag lists in doxygen documentation Add doxygen_code_blocks_runme.java Special handling for python doctest code blocks Add new doxygen test doxygen_code_blocks Handle doxygen code command with language option Improve doxygen parser handling of \code content Flag optional arguments in doxygen pydoc output Add parameter direction to doxygen pydoc output Support doxygen \param[] commands
This commit is contained in:
commit
00b47d4d1d
19 changed files with 699 additions and 437 deletions
|
|
@ -60,7 +60,7 @@ comment_verifier.check(inspect.getdoc(doxygen_basic_translate.function5),
|
|||
comment_verifier.check(inspect.getdoc(doxygen_basic_translate.function6),
|
||||
"""\
|
||||
Test for default args
|
||||
:type a: int
|
||||
:type a: int, optional
|
||||
:param a: Some parameter, default is 42"""
|
||||
)
|
||||
comment_verifier.check(inspect.getdoc(doxygen_basic_translate.function7),
|
||||
|
|
|
|||
|
|
@ -58,7 +58,7 @@ comment_verifier.check(inspect.getdoc(doxygen_basic_translate_style2.function5),
|
|||
comment_verifier.check(inspect.getdoc(doxygen_basic_translate_style2.function6),
|
||||
"""\
|
||||
Test for default args
|
||||
:type a: int
|
||||
:type a: int, optional
|
||||
:param a: Some parameter, default is 42"""
|
||||
)
|
||||
comment_verifier.check(inspect.getdoc(doxygen_basic_translate_style2.function7),
|
||||
|
|
|
|||
58
Examples/test-suite/python/doxygen_code_blocks_runme.py
Normal file
58
Examples/test-suite/python/doxygen_code_blocks_runme.py
Normal file
|
|
@ -0,0 +1,58 @@
|
|||
import doxygen_code_blocks
|
||||
import inspect
|
||||
import string
|
||||
import sys
|
||||
import comment_verifier
|
||||
|
||||
comment_verifier.check(inspect.getdoc(doxygen_code_blocks.function),
|
||||
"""\
|
||||
Test for code blocks
|
||||
|
||||
.. code-block:: c++
|
||||
|
||||
simple code block
|
||||
|
||||
More advanced usage with C++ characters:
|
||||
|
||||
.. code-block:: c++
|
||||
|
||||
std::vector<int> first; // empty vector of ints
|
||||
std::vector<int> second (4,100); // four ints with value 100
|
||||
std::vector<int> third (second.begin(),second.end()); // iterating through second
|
||||
std::vector<int> fourth (third); // a copy of third
|
||||
// the iterator constructor can also be used to construct from arrays:
|
||||
int myints[] = {16,2,77,29};
|
||||
std::vector<int> fifth (myints, myints + sizeof(myints) / sizeof(int) );
|
||||
|
||||
std::cout << "The contents of fifth are:";
|
||||
for (std::vector<int>::iterator it = fifth.begin(); it != fifth.end(); ++it)
|
||||
std::cout << ' ' << *it;
|
||||
std::cout << '\\n';
|
||||
|
||||
A code block for C:
|
||||
|
||||
.. code-block:: c
|
||||
|
||||
printf("hello world");
|
||||
|
||||
A code block for Java:
|
||||
|
||||
.. code-block:: java
|
||||
|
||||
public class HelloWorld {
|
||||
public static void main(String[] args) {
|
||||
// Prints "Hello, World" to the terminal window.
|
||||
System.out.println("Hello, World");
|
||||
}
|
||||
}
|
||||
|
||||
A code block for python:
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
print('hello world')
|
||||
|
||||
A python doctest example:
|
||||
|
||||
>>> 1 + 1
|
||||
2""")
|
||||
|
|
@ -12,7 +12,7 @@ comment_verifier.check(inspect.getdoc(doxygen_misc_constructs.getAddress),
|
|||
:param fileName: name of the file, where the source line is located
|
||||
:type line: int
|
||||
:param line: line number
|
||||
:type isGetSize: boolean
|
||||
:type isGetSize: boolean, optional
|
||||
:param isGetSize: if set, for every object location both address and size are returned
|
||||
|
||||
Connection::getId() """)
|
||||
|
|
|
|||
|
|
@ -82,7 +82,7 @@ r"""Comment for **func03()**.
|
|||
|
||||
*italicword*
|
||||
|
||||
emphazedWord
|
||||
*emphazedWord*
|
||||
|
||||
|
||||
|
||||
|
|
@ -196,7 +196,7 @@ 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
|
||||
``someword``
|
||||
|
||||
|
||||
|
||||
|
|
@ -209,7 +209,13 @@ Maybe even multiline
|
|||
|
||||
|
||||
:type a: int
|
||||
:param a: the first param""")
|
||||
:param a: the first param
|
||||
:type b: int, in
|
||||
:param b: parameter with intent(in)
|
||||
:type c: int, out
|
||||
:param c: parameter with intent(out)
|
||||
:type d: int, in/out
|
||||
:param d: parameter with intent(in,out)""")
|
||||
|
||||
comment_verifier.check(inspect.getdoc(doxygen_translate_all_tags.func08),
|
||||
r"""Text after anchor.
|
||||
|
|
|
|||
|
|
@ -80,7 +80,7 @@ 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
|
||||
``someword``
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue