Use Python-ish, not C++, parameter types in Python documentation.

Using C++ types in documentation for Python users is more harmful than
useless, so use Python types whenever possible and allow defining "doctype"
typemap to customize this for the user-defined types.
This commit is contained in:
Vadim Zeitlin 2014-07-13 00:46:31 +02:00
commit dd4c680a02
6 changed files with 74 additions and 5 deletions

View file

@ -73,7 +73,7 @@ commentVerifier.check(doxygen_basic_translate.function7.__doc__,
"""
Test for a parameter with difficult type
(mostly for python)
:type a: Shape::superType *[10]
:type a: Shape
:param a: Very strange param
"""
)

View file

@ -10,11 +10,11 @@ commentVerifier.check(doxygen_misc_constructs.getAddress.__doc__,
r"""
Returns address of file line.
:type fileName: int &
:type fileName: int
:param fileName: name of the file, where the source line is located
:type line: int
:param line: line number
:type isGetSize: bool
:type isGetSize: boolean
:param isGetSize: if set, for every object location both address and size are returned
Connection::getId()
@ -141,7 +141,7 @@ commentVerifier.check(doxygen_misc_constructs.cycle.__doc__,
main_ctrl.setBP("func1");
:type fileName: char *
:type fileName: string
:param fileName: name of the log file
"""
);