1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
|
import doxygen_overloads
import inspect
import comment_verifier
if inspect.getdoc(doxygen_overloads.overloadWithNoDoc) is not None:
raise Exception("No docstring expected for overloadWithNoDoc.")
comment_verifier.check(inspect.getdoc(doxygen_overloads.overloadWithFirstDoc),
"Doc for first overload.")
comment_verifier.check(inspect.getdoc(doxygen_overloads.overloadWithSecondDoc),
"Doc for second overload.")
comment_verifier.check(inspect.getdoc(doxygen_overloads.overloadWithBothDocs),
r"""*Overload 1:*
Doc for both overloads, first.
|
*Overload 2:*
Doc for both overloads, second.""")
comment_verifier.check(inspect.getdoc(doxygen_overloads.overloadWithSomeDocs),
r"""*Overload 1:*
Doc for some overloads, first.
|
*Overload 2:*
Doc for some overloads, third.""")
comment_verifier.check(inspect.getdoc(doxygen_overloads.overloadWithSomeOtherDocs),
r"""*Overload 1:*
Doc for some other overloads, first.
|
*Overload 2:*
Doc for some other overloads, second.""")
comment_verifier.check(inspect.getdoc(doxygen_overloads.S.staticOverloadWithFirstDoc),
"Doc for first static overload.")
comment_verifier.check(inspect.getdoc(doxygen_overloads.S.memberOverloadWithFirstDoc),
"Doc for first member overload.")
# As mentioned in doxygen_parsing_runme.py, docstrings for __init__ can't be specified when using "-builtin", so skip these checks in this case.
if not doxygen_overloads.is_python_builtin():
# Do not check for ClassWithNoDoc ctor docstring, as Python provides a standard one
# ('Initialize self. See help(type(self)) for accurate signature.') if none is explicitly specified.
comment_verifier.check(inspect.getdoc(doxygen_overloads.ClassWithFirstDoc.__init__),
"Doc for first ctor.")
comment_verifier.check(inspect.getdoc(doxygen_overloads.ClassWithSecondDoc.__init__),
"Doc for second ctor.")
comment_verifier.check(inspect.getdoc(doxygen_overloads.ClassWithBothDocs.__init__),
r"""*Overload 1:*
Doc for both ctors, first.
|
*Overload 2:*
Doc for both ctors, second.""")
comment_verifier.check(inspect.getdoc(doxygen_overloads.ClassWithSomeDocs.__init__),
r"""*Overload 1:*
Doc for some ctors, first.
|
*Overload 2:*
Doc for some ctors, third.""")
comment_verifier.check(inspect.getdoc(doxygen_overloads.ClassWithSomeOtherDocs.__init__),
r"""*Overload 1:*
Doc for some other ctors, first.
|
*Overload 2:*
Doc for some other ctors, second.""")
|
