Merge latest master into doxygen branch.
This commit is contained in:
Vadim Zeitlin
commit
9b857e6cf1
275 changed files with 6821 additions and 2094 deletions
|
|
@ -2,12 +2,25 @@ from autodoc import *
|
|||
import commentVerifier
|
||||
import sys
|
||||
|
||||
def check(got, expected, expected_builtin = None, skip = False):
|
||||
if not skip:
|
||||
expect = expected
|
||||
if is_python_builtin() and expected_builtin != None:
|
||||
expect = expected_builtin
|
||||
commentVerifier.check(got, expect)
|
||||
|
||||
commentVerifier.check(A.__doc__, "Proxy of C++ A class")
|
||||
commentVerifier.check(A.funk.__doc__, "just a string")
|
||||
commentVerifier.check(A.func0.__doc__, "func0(self, arg2, hello) -> int")
|
||||
commentVerifier.check(A.func1.__doc__, "func1(A self, short arg2, Tuple hello) -> int")
|
||||
commentVerifier.check(A.func2.__doc__, "\n"
|
||||
skip = True # skip builtin check - the autodoc is missing, but it probably should not be
|
||||
|
||||
check(A.__doc__, "Proxy of C++ A class", "::A")
|
||||
check(A.funk.__doc__, "just a string")
|
||||
check(A.func0.__doc__,
|
||||
"func0(self, arg2, hello) -> int",
|
||||
"func0(arg2, hello) -> int")
|
||||
check(A.func1.__doc__,
|
||||
"func1(A self, short arg2, Tuple hello) -> int",
|
||||
"func1(short arg2, Tuple hello) -> int")
|
||||
check(A.func2.__doc__,
|
||||
"\n"
|
||||
" func2(self, arg2, hello) -> int\n"
|
||||
"\n"
|
||||
" Parameters:\n"
|
||||
|
|
@ -15,8 +28,15 @@ commentVerifier.check(A.func2.__doc__, "\n"
|
|||
" hello: int tuple[2]\n"
|
||||
"\n"
|
||||
" "
|
||||
,
|
||||
"func2(arg2, hello) -> int\n"
|
||||
"\n"
|
||||
"Parameters:\n"
|
||||
" arg2: short\n"
|
||||
" hello: int tuple[2]\n"
|
||||
)
|
||||
commentVerifier.check(A.func3.__doc__, "\n"
|
||||
check(A.func3.__doc__,
|
||||
"\n"
|
||||
" func3(A self, short arg2, Tuple hello) -> int\n"
|
||||
"\n"
|
||||
" Parameters:\n"
|
||||
|
|
@ -24,19 +44,34 @@ commentVerifier.check(A.func3.__doc__, "\n"
|
|||
" hello: int tuple[2]\n"
|
||||
"\n"
|
||||
" "
|
||||
,
|
||||
"func3(short arg2, Tuple hello) -> int\n"
|
||||
"\n"
|
||||
"Parameters:\n"
|
||||
" arg2: short\n"
|
||||
" hello: int tuple[2]\n"
|
||||
)
|
||||
|
||||
commentVerifier.check(A.func0default.__doc__, "\n"
|
||||
check(A.func0default.__doc__,
|
||||
"\n"
|
||||
" func0default(self, e, arg3, hello, f=2) -> int\n"
|
||||
" func0default(self, e, arg3, hello) -> int\n"
|
||||
" "
|
||||
,
|
||||
"func0default(e, arg3, hello, f=2) -> int\n"
|
||||
"func0default(e, arg3, hello) -> int"
|
||||
)
|
||||
commentVerifier.check(A.func1default.__doc__, "\n"
|
||||
check(A.func1default.__doc__,
|
||||
"\n"
|
||||
" func1default(A self, A e, short arg3, Tuple hello, double f=2) -> int\n"
|
||||
" func1default(A self, A e, short arg3, Tuple hello) -> int\n"
|
||||
" "
|
||||
,
|
||||
"func1default(A e, short arg3, Tuple hello, double f=2) -> int\n"
|
||||
"func1default(A e, short arg3, Tuple hello) -> int"
|
||||
)
|
||||
commentVerifier.check(A.func2default.__doc__, "\n"
|
||||
check(A.func2default.__doc__,
|
||||
"\n"
|
||||
" func2default(self, e, arg3, hello, f=2) -> int\n"
|
||||
"\n"
|
||||
" Parameters:\n"
|
||||
|
|
@ -53,8 +88,24 @@ commentVerifier.check(A.func2default.__doc__, "\n"
|
|||
" hello: int tuple[2]\n"
|
||||
"\n"
|
||||
" "
|
||||
,
|
||||
"func2default(e, arg3, hello, f=2) -> int\n"
|
||||
"\n"
|
||||
"Parameters:\n"
|
||||
" e: A *\n"
|
||||
" arg3: short\n"
|
||||
" hello: int tuple[2]\n"
|
||||
" f: double\n"
|
||||
"\n"
|
||||
"func2default(e, arg3, hello) -> int\n"
|
||||
"\n"
|
||||
"Parameters:\n"
|
||||
" e: A *\n"
|
||||
" arg3: short\n"
|
||||
" hello: int tuple[2]\n"
|
||||
)
|
||||
commentVerifier.check(A.func3default.__doc__, "\n"
|
||||
check(A.func3default.__doc__,
|
||||
"\n"
|
||||
" func3default(A self, A e, short arg3, Tuple hello, double f=2) -> int\n"
|
||||
"\n"
|
||||
" Parameters:\n"
|
||||
|
|
@ -71,19 +122,43 @@ commentVerifier.check(A.func3default.__doc__, "\n"
|
|||
" hello: int tuple[2]\n"
|
||||
"\n"
|
||||
" "
|
||||
,
|
||||
"func3default(A e, short arg3, Tuple hello, double f=2) -> int\n"
|
||||
"\n"
|
||||
"Parameters:\n"
|
||||
" e: A *\n"
|
||||
" arg3: short\n"
|
||||
" hello: int tuple[2]\n"
|
||||
" f: double\n"
|
||||
"\n"
|
||||
"func3default(A e, short arg3, Tuple hello) -> int\n"
|
||||
"\n"
|
||||
"Parameters:\n"
|
||||
" e: A *\n"
|
||||
" arg3: short\n"
|
||||
" hello: int tuple[2]\n"
|
||||
)
|
||||
|
||||
commentVerifier.check(A.func0static.__doc__, "\n"
|
||||
check(A.func0static.__doc__,
|
||||
"\n"
|
||||
" func0static(e, arg2, hello, f=2) -> int\n"
|
||||
" func0static(e, arg2, hello) -> int\n"
|
||||
" "
|
||||
,
|
||||
"func0static(e, arg2, hello, f=2) -> int\n"
|
||||
"func0static(e, arg2, hello) -> int"
|
||||
)
|
||||
commentVerifier.check(A.func1static.__doc__, "\n"
|
||||
check(A.func1static.__doc__,
|
||||
"\n"
|
||||
" func1static(A e, short arg2, Tuple hello, double f=2) -> int\n"
|
||||
" func1static(A e, short arg2, Tuple hello) -> int\n"
|
||||
" "
|
||||
,
|
||||
"func1static(A e, short arg2, Tuple hello, double f=2) -> int\n"
|
||||
"func1static(A e, short arg2, Tuple hello) -> int"
|
||||
)
|
||||
commentVerifier.check(A.func2static.__doc__, "\n"
|
||||
check(A.func2static.__doc__,
|
||||
"\n"
|
||||
" func2static(e, arg2, hello, f=2) -> int\n"
|
||||
"\n"
|
||||
" Parameters:\n"
|
||||
|
|
@ -100,8 +175,24 @@ commentVerifier.check(A.func2static.__doc__, "\n"
|
|||
" hello: int tuple[2]\n"
|
||||
"\n"
|
||||
" "
|
||||
,
|
||||
"func2static(e, arg2, hello, f=2) -> int\n"
|
||||
"\n"
|
||||
"Parameters:\n"
|
||||
" e: A *\n"
|
||||
" arg2: short\n"
|
||||
" hello: int tuple[2]\n"
|
||||
" f: double\n"
|
||||
"\n"
|
||||
"func2static(e, arg2, hello) -> int\n"
|
||||
"\n"
|
||||
"Parameters:\n"
|
||||
" e: A *\n"
|
||||
" arg2: short\n"
|
||||
" hello: int tuple[2]\n"
|
||||
)
|
||||
commentVerifier.check(A.func3static.__doc__, "\n"
|
||||
check(A.func3static.__doc__,
|
||||
"\n"
|
||||
" func3static(A e, short arg2, Tuple hello, double f=2) -> int\n"
|
||||
"\n"
|
||||
" Parameters:\n"
|
||||
|
|
@ -118,29 +209,58 @@ commentVerifier.check(A.func3static.__doc__, "\n"
|
|||
" hello: int tuple[2]\n"
|
||||
"\n"
|
||||
" "
|
||||
,
|
||||
"func3static(A e, short arg2, Tuple hello, double f=2) -> int\n"
|
||||
"\n"
|
||||
"Parameters:\n"
|
||||
" e: A *\n"
|
||||
" arg2: short\n"
|
||||
" hello: int tuple[2]\n"
|
||||
" f: double\n"
|
||||
"\n"
|
||||
"func3static(A e, short arg2, Tuple hello) -> int\n"
|
||||
"\n"
|
||||
"Parameters:\n"
|
||||
" e: A *\n"
|
||||
" arg2: short\n"
|
||||
" hello: int tuple[2]\n"
|
||||
)
|
||||
|
||||
if sys.version_info[0:2] > (2, 4):
|
||||
# Python 2.4 does not seem to work
|
||||
commentVerifier.check(A.variable_a.__doc__, "A_variable_a_get(self) -> int")
|
||||
commentVerifier.check(A.variable_b.__doc__, "A_variable_b_get(A self) -> int")
|
||||
commentVerifier.check(A.variable_c.__doc__,
|
||||
check(A.variable_a.__doc__,
|
||||
"A_variable_a_get(self) -> int",
|
||||
"A.variable_a"
|
||||
)
|
||||
check(A.variable_b.__doc__,
|
||||
"A_variable_b_get(A self) -> int",
|
||||
"A.variable_b"
|
||||
)
|
||||
check(A.variable_c.__doc__,
|
||||
"A_variable_c_get(self) -> int\n"
|
||||
"\n"
|
||||
"Parameters:\n"
|
||||
" self: A *\n"
|
||||
,
|
||||
"A.variable_c"
|
||||
)
|
||||
commentVerifier.check(A.variable_d.__doc__,
|
||||
check(A.variable_d.__doc__,
|
||||
"A_variable_d_get(A self) -> int\n"
|
||||
"\n"
|
||||
"Parameters:\n"
|
||||
" self: A *\n"
|
||||
,
|
||||
"A.variable_d"
|
||||
)
|
||||
|
||||
commentVerifier.check(B.__doc__, "Proxy of C++ B class")
|
||||
commentVerifier.check(C.__init__.__doc__, "__init__(self, a, b, h) -> C")
|
||||
commentVerifier.check(D.__init__.__doc__, "__init__(D self, int a, int b, Hola h) -> D")
|
||||
commentVerifier.check(E.__init__.__doc__, "\n"
|
||||
check(B.__doc__,
|
||||
"Proxy of C++ B class",
|
||||
"::B"
|
||||
)
|
||||
check(C.__init__.__doc__, "__init__(self, a, b, h) -> C", None, skip)
|
||||
check(D.__init__.__doc__, "__init__(D self, int a, int b, Hola h) -> D", None, skip)
|
||||
check(E.__init__.__doc__,
|
||||
"\n"
|
||||
" __init__(self, a, b, h) -> E\n"
|
||||
"\n"
|
||||
" Parameters:\n"
|
||||
|
|
@ -149,8 +269,10 @@ commentVerifier.check(E.__init__.__doc__, "\n"
|
|||
" h: enum Hola\n"
|
||||
"\n"
|
||||
" "
|
||||
, None, skip
|
||||
)
|
||||
commentVerifier.check(F.__init__.__doc__, "\n"
|
||||
check(F.__init__.__doc__,
|
||||
"\n"
|
||||
" __init__(F self, int a, int b, Hola h) -> F\n"
|
||||
"\n"
|
||||
" Parameters:\n"
|
||||
|
|
@ -159,14 +281,21 @@ commentVerifier.check(F.__init__.__doc__, "\n"
|
|||
" h: enum Hola\n"
|
||||
"\n"
|
||||
" "
|
||||
, None, skip
|
||||
)
|
||||
|
||||
commentVerifier.check(B.funk.__doc__, "funk(B self, int c, int d) -> int")
|
||||
commentVerifier.check(funk.__doc__, "funk(A e, short arg2, int c, int d) -> int")
|
||||
commentVerifier.check(funkdefaults.__doc__, "\n"
|
||||
check(B.funk.__doc__,
|
||||
"funk(B self, int c, int d) -> int",
|
||||
"funk(int c, int d) -> int")
|
||||
check(funk.__doc__, "funk(A e, short arg2, int c, int d) -> int")
|
||||
check(funkdefaults.__doc__,
|
||||
"\n"
|
||||
" funkdefaults(A e, short arg2, int c, int d, double f=2) -> int\n"
|
||||
" funkdefaults(A e, short arg2, int c, int d) -> int\n"
|
||||
" "
|
||||
,
|
||||
"funkdefaults(A e, short arg2, int c, int d, double f=2) -> int\n"
|
||||
"funkdefaults(A e, short arg2, int c, int d) -> int"
|
||||
)
|
||||
|
||||
commentVerifier.check(func_input.__doc__, "func_input(int * INPUT) -> int")
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue