warnings eliminated, examples fixed, only doxygen_misc_constructs is not working now
This commit is contained in:
parent
f6fc808534
commit
43eeb4528c
5 changed files with 116 additions and 5 deletions
|
|
@ -70,6 +70,8 @@ int func02(int a)
|
|||
|
||||
|
||||
/**
|
||||
* Comment for \b func03().
|
||||
*
|
||||
* \dir /somePath/someFolder
|
||||
*
|
||||
* \dontinclude someFile.h
|
||||
|
|
@ -176,6 +178,8 @@ int func05(int a)
|
|||
|
||||
|
||||
/**
|
||||
* Comment for \b func06().
|
||||
*
|
||||
* \interface someInterface someHeader.h "Header name"
|
||||
*
|
||||
* \latexonly
|
||||
|
|
@ -218,6 +222,8 @@ int func06(int a)
|
|||
|
||||
|
||||
/**
|
||||
* Comment for \b func07().
|
||||
*
|
||||
* \name someHeader.h
|
||||
*
|
||||
* \namespace someNamespace
|
||||
|
|
@ -384,4 +390,16 @@ int func10(int a, float b)
|
|||
{
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* \interface someInterface someHeader.h "Header name"
|
||||
*
|
||||
* Because of structural Doxygen command at the start of comment block,
|
||||
* the whoile comment block is ignored. See parser.y, f. isStructuralDoxygen()
|
||||
* or documentation for the list of commands.
|
||||
*/
|
||||
int func11(int a, float b)
|
||||
{
|
||||
}
|
||||
|
||||
%}
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
import com.sun.javadoc.*;
|
||||
import java.util.HashMap;
|
||||
import java.util.Map.Entry;
|
||||
import java.util.Map;
|
||||
import java.util.Set;
|
||||
import java.util.Iterator;
|
||||
import java.io.BufferedWriter;
|
||||
import java.io.OutputStreamWriter;
|
||||
|
|
@ -88,8 +90,15 @@ public class commentParser {
|
|||
}
|
||||
}
|
||||
|
||||
if (parsedComments.size() < wantedComments.size()) {
|
||||
System.out.println("Found " + (wantedComments.size()-parsedComments.size()) + " missed comment(s)!");
|
||||
if (parsedComments.size() != wantedComments.size()) {
|
||||
System.out.println("Mismatch in the number of comments!\n Expected: " +
|
||||
wantedComments.size() + "\n Parsed: " +
|
||||
parsedComments.size());
|
||||
System.out.println("Expected keys: ");
|
||||
printKeys(wantedComments);
|
||||
System.out.println("Parsed keys: ");
|
||||
printKeys(parsedComments);
|
||||
|
||||
errorCount++;
|
||||
}
|
||||
|
||||
|
|
@ -97,6 +106,14 @@ public class commentParser {
|
|||
}
|
||||
|
||||
|
||||
private static void printKeys(Map map) {
|
||||
Set<String> keys = map.keySet();
|
||||
for (String key : keys) {
|
||||
System.out.println(" " + key);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
public static void printCommentListForJavaSource() {
|
||||
Iterator< Entry<String, String> > it = parsedComments.entrySet().iterator();
|
||||
while (it.hasNext())
|
||||
|
|
|
|||
|
|
@ -51,8 +51,11 @@ public class doxygen_translate_all_tags_runme {
|
|||
" and detailed description of some thing \n");
|
||||
|
||||
wantedComments.put("doxygen_translate_all_tags.doxygen_translate_all_tags.func03(int)",
|
||||
" Comment for <b>func03().</b>\n" +
|
||||
" <i>italicword </i>\n" +
|
||||
" <i>emphazedWord </i>\n");
|
||||
" <i>emphazedWord </i>\n" +
|
||||
" @ example someFile.txt\n" +
|
||||
" Some details on using the example");
|
||||
|
||||
wantedComments.put("doxygen_translate_all_tags.doxygen_translate_all_tags.func04(int)",
|
||||
" @exception SuperError \n" +
|
||||
|
|
@ -80,6 +83,7 @@ public class doxygen_translate_all_tags_runme {
|
|||
" describing invariant. \n");
|
||||
|
||||
wantedComments.put("doxygen_translate_all_tags.doxygen_translate_all_tags.func06(int)",
|
||||
" Comment for <b>func06().</b>\n" +
|
||||
" This will only appear in LATeX \n" +
|
||||
" <ul> \n" +
|
||||
" <li>Some unordered list \n" +
|
||||
|
|
@ -90,6 +94,7 @@ public class doxygen_translate_all_tags_runme {
|
|||
" This will only appear in man\n");
|
||||
|
||||
wantedComments.put("doxygen_translate_all_tags.doxygen_translate_all_tags.func07(int)",
|
||||
" Comment for <b>func07().</b>\n" +
|
||||
" Note: Here \n" +
|
||||
" is the note! \n" +
|
||||
" This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.\n" +
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue