only whitespace cnhanges and code comment update
This commit is contained in:
Marko Klopcic
parent
a2a345be39
commit
2896938879
4 changed files with 86 additions and 79 deletions
|
|
@ -26,129 +26,126 @@ public class doxygen_misc_constructs_runme {
|
|||
HashMap<String, String> wantedComments = new HashMap<String, String>();
|
||||
|
||||
wantedComments.put("doxygen_misc_constructs.doxygen_misc_constructs.getConnection()",
|
||||
" \n" +
|
||||
" \n" +
|
||||
" This function returns connection id. \n" +
|
||||
" \n" +
|
||||
"\n" +
|
||||
"\n" +
|
||||
" This function returns connection id.\n" +
|
||||
"\n" +
|
||||
"");
|
||||
wantedComments.put("doxygen_misc_constructs.doxygen_misc_constructs.getAddress(doxygen_misc_constructs.SWIGTYPE_p_int, int)",
|
||||
" Returns address of file line. \n" +
|
||||
" \n" +
|
||||
" @param fileName name of the file, where the source line is located \n" +
|
||||
" @param line line number \n" +
|
||||
" {@link Connection::getId() }<br> \n" +
|
||||
" Returns address of file line.\n" +
|
||||
" \n" +
|
||||
" @param fileName name of the file, where the source line is located\n" +
|
||||
" @param line line number\n" +
|
||||
" {@link Connection::getId() }<br>\n" +
|
||||
"\n" +
|
||||
"");
|
||||
wantedComments.put("doxygen_misc_constructs.doxygen_misc_constructs.getG_zipCode()",
|
||||
" Tag endlink must be recognized also when it is the last token \n" +
|
||||
" in the commment. \n" +
|
||||
" Tag endlink must be recognized also when it is the last token\n" +
|
||||
" in the commment.\n" +
|
||||
" \n" +
|
||||
" {@link Connection::getId() }<br> \n" +
|
||||
" {@link Connection::getId() }<br>\n" +
|
||||
" {@link debugIdeTraceProfilerCoverageSample.py Python example. }\n" +
|
||||
" \n" +
|
||||
"\n" +
|
||||
"");
|
||||
wantedComments.put("doxygen_misc_constructs.doxygen_misc_constructs.setG_zipCode(int)",
|
||||
" Tag endlink must be recognized also when it is the last token \n" +
|
||||
" in the commment. \n" +
|
||||
" \n" +
|
||||
" {@link Connection::getId() }<br> \n" +
|
||||
" Tag endlink must be recognized also when it is the last token\n" +
|
||||
" in the commment.\n" +
|
||||
"\n" +
|
||||
" {@link Connection::getId() }<br>\n" +
|
||||
" {@link debugIdeTraceProfilerCoverageSample.py Python example. }\n" +
|
||||
" \n" +
|
||||
"\n" +
|
||||
"");
|
||||
wantedComments.put("doxygen_misc_constructs.doxygen_misc_constructs.getG_counter()",
|
||||
" Tag endlink must be recognized also when followed by nonspace charater. \n" +
|
||||
" \n" +
|
||||
" {@link Connection::getId() }<br> \n" +
|
||||
" \n" +
|
||||
" Tag endlink must be recognized also when followed by nonspace charater.\n" +
|
||||
"\n" +
|
||||
" {@link Connection::getId() }<br>\n" +
|
||||
"\n" +
|
||||
"");
|
||||
wantedComments.put("doxygen_misc_constructs.doxygen_misc_constructs.waitTime(int)",
|
||||
" Determines how long the <code>isystem.connect</code> should wait for running \n" +
|
||||
" instances to respond. Only one of <code>lfWaitXXX</code> flags from IConnect::ELaunchFlags \n" +
|
||||
" may be specified. \n" +
|
||||
" \n" +
|
||||
" Determines how long the <code>isystem.connect</code> should wait for running\n" +
|
||||
" instances to respond. Only one of <code>lfWaitXXX</code> flags from IConnect::ELaunchFlags\n" +
|
||||
" may be specified.\n" +
|
||||
"\n" +
|
||||
"");
|
||||
wantedComments.put("doxygen_misc_constructs.CConnectionConfig",
|
||||
" This class contains information for connection to winIDEA. Its methods \n" +
|
||||
" return reference to self, so we can use it like this: \n" +
|
||||
" <pre> \n" +
|
||||
" CConnectionConfig config = new CConnectionConfig(); \n" +
|
||||
" config.discoveryPort(5534).dllPath(\"C:\\\\myWinIDEA\\\\connect.dll\").id(\"main\"); \n" +
|
||||
" </pre> \n" +
|
||||
" \n" +
|
||||
" All parameters are optional. Set only what is required, default values are \n" +
|
||||
" used for unspecified parameters. \n" +
|
||||
" <p> \n" +
|
||||
" \n" +
|
||||
" {@link advancedWinIDEALaunching.py Python example. }<br> \n" +
|
||||
" \n" +
|
||||
" This class contains information for connection to winIDEA. Its methods\n" +
|
||||
" return reference to self, so we can use it like this:\n" +
|
||||
" <pre>\n" +
|
||||
" CConnectionConfig config = new CConnectionConfig();\n" +
|
||||
" config.discoveryPort(5534).dllPath(\"C:\\\\myWinIDEA\\\\connect.dll\").id(\"main\");\n" +
|
||||
" </pre>\n" +
|
||||
"\n" +
|
||||
" All parameters are optional. Set only what is required, default values are\n" +
|
||||
" used for unspecified parameters.\n" +
|
||||
" <p>\n" +
|
||||
"\n" +
|
||||
" {@link advancedWinIDEALaunching.py Python example. }<br>\n" +
|
||||
"\n" +
|
||||
"");
|
||||
wantedComments.put("doxygen_misc_constructs.doxygen_misc_constructs.getAddress(doxygen_misc_constructs.SWIGTYPE_p_int, int, boolean)",
|
||||
" Returns address of file line. \n" +
|
||||
" \n" +
|
||||
" @param fileName name of the file, where the source line is located \n" +
|
||||
" @param line line number \n" +
|
||||
" @param isGetSize if set, for every object location both address and size are returned \n" +
|
||||
" \n" +
|
||||
" {@link Connection::getId() }<br> \n" +
|
||||
" \n" +
|
||||
" Returns address of file line.\n" +
|
||||
"\n" +
|
||||
" @param fileName name of the file, where the source line is located\n" +
|
||||
" @param line line number\n" +
|
||||
" @param isGetSize if set, for every object location both address and size are returned\n" +
|
||||
"\n" +
|
||||
" {@link Connection::getId() }<br>\n" +
|
||||
"\n" +
|
||||
"");
|
||||
wantedComments.put("doxygen_misc_constructs.doxygen_misc_constructs.setG_counter(char)",
|
||||
" Tag endlink must be recognized also when followed by nonspace charater. \n" +
|
||||
" \n" +
|
||||
" {@link Connection::getId() }<br> \n" +
|
||||
" \n" +
|
||||
" Tag endlink must be recognized also when followed by nonspace charater.\n" +
|
||||
"\n" +
|
||||
" {@link Connection::getId() }<br>\n" +
|
||||
"\n" +
|
||||
"");
|
||||
|
||||
wantedComments.put("doxygen_misc_constructs.ClassWithNestedEnum",
|
||||
" Class description.\n" +
|
||||
" \n");
|
||||
"\n");
|
||||
|
||||
wantedComments.put("doxygen_misc_constructs.ClassWithNestedEnum.ENested",
|
||||
" Enum description.\n" +
|
||||
" \n");
|
||||
"\n");
|
||||
|
||||
wantedComments.put("doxygen_misc_constructs.ClassWithNestedEnum.ENested.ONE",
|
||||
" desc of one\n" +
|
||||
" \n");
|
||||
" desc of one\n");
|
||||
|
||||
wantedComments.put("doxygen_misc_constructs.ClassWithNestedEnum.ENested.TWO",
|
||||
" desc of two\n" +
|
||||
" \n");
|
||||
" desc of two\n");
|
||||
|
||||
wantedComments.put("doxygen_misc_constructs.ClassWithNestedEnum.ENested.THREE",
|
||||
" desc of three\n" +
|
||||
" \n");
|
||||
" desc of three\n");
|
||||
|
||||
wantedComments.put("doxygen_misc_constructs.doxygen_misc_constructs.isNoSpaceValidA()",
|
||||
" This comment without space after '*' is valid in Doxygen. \n" +
|
||||
" \n" +
|
||||
" This comment without space after '*' is valid in Doxygen.\n" +
|
||||
"\n" +
|
||||
"");
|
||||
|
||||
wantedComments.put("doxygen_misc_constructs.doxygen_misc_constructs.isNoSpaceValidB()",
|
||||
" .This comment without space after '*' is valid in Doxygen. \n" +
|
||||
" \n" +
|
||||
" .This comment without space after '*' is valid in Doxygen.\n" +
|
||||
"\n" +
|
||||
"");
|
||||
|
||||
wantedComments.put("doxygen_misc_constructs.doxygen_misc_constructs.backslashA()",
|
||||
" Backslash following<code>word</code> is a valid doxygen command. Output contains\n" +
|
||||
" 'followingword' with 'word' in code font. \n" +
|
||||
" \n" +
|
||||
" 'followingword' with 'word' in code font.\n" +
|
||||
"\n" +
|
||||
"");
|
||||
|
||||
wantedComments.put("doxygen_misc_constructs.doxygen_misc_constructs.backslashB()",
|
||||
" Doxy command without trailing space is ignored - nothing appears\n" +
|
||||
" on output. Standalone \\ and '\\' get to output. \n" +
|
||||
" Standalone @ and '@' get to output. \n" +
|
||||
" Commands \"in quoted \\b strings are treated as plain text\". \n" +
|
||||
" Commands not recognized by Doxygen are ignored. \n" +
|
||||
" Backslashes in DOS paths d: and words \n" +
|
||||
" following them do not appear on output, we must quote them with \n" +
|
||||
" double quotes: \"d:\\xyz\\qwe\\myfile\", \"@something\". Single quotes do not help: \n" +
|
||||
" 'd: '. Escaping works: d:\\xyz\\qwe\\myfile. Unix \n" +
|
||||
" paths of course have no such problems: /xyz/qwe/myfile \n" +
|
||||
" on output. Standalone \\ and '\\' get to output.\n" +
|
||||
" Standalone @ and '@' get to output.\n" +
|
||||
" Commands \"in quoted \\b strings are treated as plain text\".\n" +
|
||||
" Commands not recognized by Doxygen are ignored.\n" +
|
||||
" Backslashes in DOS paths d:and words\n" +
|
||||
" following them do not appear on output, we must quote them with\n" +
|
||||
" double quotes: \"d:\\xyz\\qwe\\myfile\", \"@something\". Single quotes do not help:\n" +
|
||||
" 'd:'. Escaping works: d:\\xyz\\qwe\\myfile. Unix\n" +
|
||||
" paths of course have no such problems: /xyz/qwe/myfile\n" +
|
||||
" Commands for escaped symbols:\n" +
|
||||
" $ @ \\ & ~ < > # % " . :: @text ::text" +
|
||||
" \n");
|
||||
"\n");
|
||||
|
||||
wantedComments.put("doxygen_misc_constructs.doxygen_misc_constructs.backslashC()",
|
||||
" Backslash e at end of <i>line</i> froze SWIG\n" +
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue