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

improved handling of word commands if puntuation is following the word, preserved spaces at start of comment line

Browse source
This commit is contained in:
Marko Klopcic 2013-02-21 09:05:11 +01:00
commit b5dea7456b
8 changed files with 224 additions and 130 deletions
Download patch file Download diff file Expand all files Collapse all files

64
Examples/test-suite/python/autodoc_runme.py
View file

@ -1,14 +1,12 @@
from autodoc import *
import commentVerifier
def check(got, expected):
if expected != got:
raise RuntimeError("\n" + "Expected: [" + str(expected) + "]\n" + "Got : [" + str(got) + "]")
check(A.__doc__, "Proxy of C++ A class")
check(A.funk.__doc__, "just a string")
check(A.func0.__doc__, "func0(self, arg2, hello) -> int")
check(A.func1.__doc__, "func1(A self, short arg2, Tuple hello) -> int")
check(A.func2.__doc__, "\n"
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"
" func2(self, arg2, hello) -> int\n"
"\n"
" Parameters:\n"
@ -17,7 +15,7 @@ check(A.func2.__doc__, "\n"
"\n"
" "
)
check(A.func3.__doc__, "\n"
commentVerifier.check(A.func3.__doc__, "\n"
" func3(A self, short arg2, Tuple hello) -> int\n"
"\n"
" Parameters:\n"
@ -27,17 +25,17 @@ check(A.func3.__doc__, "\n"
" "
)
check(A.func0default.__doc__, "\n"
commentVerifier.check(A.func0default.__doc__, "\n"
" func0default(self, e, arg3, hello, f=2) -> int\n"
" func0default(self, e, arg3, hello) -> int\n"
" "
)
check(A.func1default.__doc__, "\n"
commentVerifier.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"
" "
)
check(A.func2default.__doc__, "\n"
commentVerifier.check(A.func2default.__doc__, "\n"
" func2default(self, e, arg3, hello, f=2) -> int\n"
"\n"
" Parameters:\n"
@ -55,7 +53,7 @@ check(A.func2default.__doc__, "\n"
"\n"
" "
)
check(A.func3default.__doc__, "\n"
commentVerifier.check(A.func3default.__doc__, "\n"
" func3default(A self, A e, short arg3, Tuple hello, double f=2) -> int\n"
"\n"
" Parameters:\n"
@ -74,17 +72,17 @@ check(A.func3default.__doc__, "\n"
" "
)
check(A.func0static.__doc__, "\n"
commentVerifier.check(A.func0static.__doc__, "\n"
" func0static(e, arg2, hello, f=2) -> int\n"
" func0static(e, arg2, hello) -> int\n"
" "
)
check(A.func1static.__doc__, "\n"
commentVerifier.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"
" "
)
check(A.func2static.__doc__, "\n"
commentVerifier.check(A.func2static.__doc__, "\n"
" func2static(e, arg2, hello, f=2) -> int\n"
"\n"
" Parameters:\n"
@ -102,7 +100,7 @@ check(A.func2static.__doc__, "\n"
"\n"
" "
)
check(A.func3static.__doc__, "\n"
commentVerifier.check(A.func3static.__doc__, "\n"
" func3static(A e, short arg2, Tuple hello, double f=2) -> int\n"
"\n"
" Parameters:\n"
@ -121,16 +119,16 @@ check(A.func3static.__doc__, "\n"
" "
)
check(A.variable_a.__doc__, "A_variable_a_get(self) -> int")
check(A.variable_b.__doc__, "A_variable_b_get(A self) -> int")
check(A.variable_c.__doc__, "\n"
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__, "\n"
"A_variable_c_get(self) -> int\n"
"\n"
"Parameters:\n"
" self: A *\n"
"\n"
)
check(A.variable_d.__doc__, "\n"
commentVerifier.check(A.variable_d.__doc__, "\n"
"A_variable_d_get(A self) -> int\n"
"\n"
"Parameters:\n"
@ -138,10 +136,10 @@ check(A.variable_d.__doc__, "\n"
"\n"
)
check(B.__doc__, "Proxy of C++ B class")
check(C.__init__.__doc__, "__init__(self, a, b, h) -> C")
check(D.__init__.__doc__, "__init__(D self, int a, int b, Hola h) -> D")
check(E.__init__.__doc__, "\n"
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"
" __init__(self, a, b, h) -> E\n"
"\n"
" Parameters:\n"
@ -151,7 +149,7 @@ check(E.__init__.__doc__, "\n"
"\n"
" "
)
check(F.__init__.__doc__, "\n"
commentVerifier.check(F.__init__.__doc__, "\n"
" __init__(F self, int a, int b, Hola h) -> F\n"
"\n"
" Parameters:\n"
@ -162,15 +160,15 @@ check(F.__init__.__doc__, "\n"
" "
)
check(B.funk.__doc__, "funk(B self, int c, int d) -> int")
check(funk.__doc__, "funk(A e, short arg2, int c, int d) -> int")
check(funkdefaults.__doc__, "\n"
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"
" 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"
" "
)
check(func_input.__doc__, "func_input(int * INPUT) -> int")
check(func_output.__doc__, "func_output() -> int")
check(func_inout.__doc__, "func_inout(int * INOUT) -> int")
check(banana.__doc__, "banana(S a, S b, int c, Integer d)")
commentVerifier.check(func_input.__doc__, "func_input(int * INPUT) -> int")
commentVerifier.check(func_output.__doc__, "func_output() -> int")
commentVerifier.check(func_inout.__doc__, "func_inout(int * INOUT) -> int")
commentVerifier.check(banana.__doc__, "banana(S a, S b, int c, Integer d)")

31
Examples/test-suite/python/doxygen_misc_constructs_runme.py
View file

@ -110,6 +110,35 @@ commentVerifier.check(doxygen_misc_constructs.backslashC.__doc__,
_with_ old comment parser.
See also: MyClass::fun(char,
float)
float)
"""
)
commentVerifier.check(doxygen_misc_constructs.cycle.__doc__,
r"""
The next line contains expression:
['retVal < 10', 'g_counter == 23 && g_mode & 3']
Both words should be emphasized __isystem.connect__.
But not the last period. For __example__, comma should not be emphasized.
Similar __for__: double colon.
Spaces at the start of line should be taken into account:
Arguments:
id (int) -- used as prefix in log
statements. The default value is empty string, which is OK if
there is only one app. instance. Example:
ctrl.setBP("func1");
If we set the id to 'main_', we get:
main_ctrl.setBP("func1");
fileName (char *) -- name of the log file
"""
);

34
Examples/test-suite/python/doxygen_translate_all_tags_runme.py
View file

@ -67,7 +67,7 @@ r"""
commentVerifier.check(doxygen_translate_all_tags.func03.__doc__,
r"""
Comment for __func03().__
Comment for __func03()__.
@ -96,11 +96,11 @@ r"""
\sqrt{(x_2-x_1)^2+(y_2-y_1)^2}
\sqrt{(x_2-x_1)^2+(y_2-y_1)^2}
\sqrt{(x_2-x_1)^2+(y_2-y_1)^2}
\sqrt{(x_2-x_1)^2+(y_2-y_1)^2}
\sqrt{(x_2-x_1)^2+(y_2-y_1)^2}
@ -120,21 +120,21 @@ r"""
commentVerifier.check(doxygen_translate_all_tags.func05.__doc__,
r"""
If: ANOTHERCONDITION {
First part of comment
If: SECONDCONDITION {
Nested condition text
}Else if: THIRDCONDITION {
The third condition text
}Else: {The last text block
}
}Else: {Second part of comment
If: CONDITION {
Second part extended
}
First part of comment
If: SECONDCONDITION {
Nested condition text
}Else if: THIRDCONDITION {
The third condition text
}Else: { The last text block
}
}Else: { Second part of comment
If: CONDITION {
Second part extended
}
}
If not: SOMECONDITION {
This is printed if not
This is printed if not
}
Image: testImage.bmp("Hello, world!")
@ -155,7 +155,7 @@ r"""
commentVerifier.check(doxygen_translate_all_tags.func06.__doc__,
r"""
Comment for __func06().__
Comment for __func06()__.
@ -194,7 +194,7 @@ r"""
commentVerifier.check(doxygen_translate_all_tags.func07.__doc__,
r"""
Comment for __func07().__
Comment for __func07()__.

24
Examples/test-suite/python/doxygen_translate_runme.py
View file

@ -40,21 +40,21 @@ r"""
Throws: SuperError
If: ANOTHERCONDITION {
First part of comment
If: SECONDCONDITION {
Nested condition text
}Else if: THIRDCONDITION {
The third condition text
}Else: {The last text block
}
}Else: {Second part of comment
If: CONDITION {
Second part extended
}
First part of comment
If: SECONDCONDITION {
Nested condition text
}Else if: THIRDCONDITION {
The third condition text
}Else: { The last text block
}
}Else: { Second part of comment
If: CONDITION {
Second part extended
}
}
If not: SOMECONDITION {
This is printed if not
This is printed if not
}
Image: testImage.bmp("Hello, world!")