jyapayne/swig
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

PEP8 conformance for comment verifier module

Browse source
This commit is contained in:
William S Fulton 2018-05-24 19:28:15 +01:00
commit 95caf87596
11 changed files with 67 additions and 67 deletions
Download patch file Download diff file Expand all files Collapse all files

22
Examples/test-suite/python/doxygen_parsing_runme.py
View file

@ -5,20 +5,20 @@ import inspect
import string
import os
import sys
import commentVerifier
import comment_verifier
commentVerifier.check(inspect.getdoc(doxygen_parsing.someFunction),
comment_verifier.check(inspect.getdoc(doxygen_parsing.someFunction),
"The function comment")
commentVerifier.check(inspect.getdoc(doxygen_parsing.SomeClass),
comment_verifier.check(inspect.getdoc(doxygen_parsing.SomeClass),
"The class comment")
commentVerifier.check(inspect.getdoc(doxygen_parsing.SomeStruct),
comment_verifier.check(inspect.getdoc(doxygen_parsing.SomeStruct),
"The struct comment")
# There doesn't seem to be any way to specify the doc string for __init__ when
# using "-builtin" (see http://stackoverflow.com/q/11913492/15275), so skip
# this test in this case.
if str(os.environ.get('SWIG_FEATURES')).find('-builtin') == -1:
commentVerifier.check(inspect.getdoc(doxygen_parsing.SomeAnotherClass.__init__),
comment_verifier.check(inspect.getdoc(doxygen_parsing.SomeAnotherClass.__init__),
r"""*Overload 1:*
First overloaded constructor.
@ -27,11 +27,11 @@ First overloaded constructor.
*Overload 2:*
Second overloaded constructor.""")
commentVerifier.check(inspect.getdoc(doxygen_parsing.SomeAnotherClass.classMethod),
comment_verifier.check(inspect.getdoc(doxygen_parsing.SomeAnotherClass.classMethod),
r"""The class method comment.
SomeAnotherClass#classMethodExtended(int, int) a link text""")
commentVerifier.check(inspect.getdoc(doxygen_parsing.SomeAnotherClass.classMethodExtended),
comment_verifier.check(inspect.getdoc(doxygen_parsing.SomeAnotherClass.classMethodExtended),
r"""The class method with parameter
:type a: int
@ -39,7 +39,7 @@ commentVerifier.check(inspect.getdoc(doxygen_parsing.SomeAnotherClass.classMetho
:type b: int
:param b: Parameter b"""
)
commentVerifier.check(inspect.getdoc(doxygen_parsing.SomeAnotherClass.classMethodExtended2),
comment_verifier.check(inspect.getdoc(doxygen_parsing.SomeAnotherClass.classMethodExtended2),
r"""The class method with parameter
:type a: int
@ -47,9 +47,9 @@ commentVerifier.check(inspect.getdoc(doxygen_parsing.SomeAnotherClass.classMetho
:type b: int
:param b: Parameter b"""
)
commentVerifier.check(inspect.getdoc(doxygen_parsing.SomeAnotherStruct.structMethod),
comment_verifier.check(inspect.getdoc(doxygen_parsing.SomeAnotherStruct.structMethod),
r"""The struct method comment""")
commentVerifier.check(inspect.getdoc(doxygen_parsing.SomeAnotherStruct.structMethodExtended),
comment_verifier.check(inspect.getdoc(doxygen_parsing.SomeAnotherStruct.structMethodExtended),
r"""The struct method with parameter
:type a: int
@ -57,7 +57,7 @@ commentVerifier.check(inspect.getdoc(doxygen_parsing.SomeAnotherStruct.structMet
:type b: int
:param b: Parameter b"""
)
commentVerifier.check(inspect.getdoc(doxygen_parsing.SomeAnotherStruct.structMethodExtended2),
comment_verifier.check(inspect.getdoc(doxygen_parsing.SomeAnotherStruct.structMethodExtended2),
r"""The struct method with parameter
:type a: int