", "", "
", "", "", "",
- "", "", "", "| ", " | ", " | ", "", "", "", ""
+// '<' is prepended to distinguish HTML tags from Doxygen commands.
+const char *commandHtml[] = {
+ "
};
-const int htmlEntitiesSize = sizeof(htmlEntities) / sizeof(*htmlEntities);
+const int commandHtmlEntitiesSize = sizeof(commandHtmlEntities) / sizeof(*commandHtmlEntities);
#endif
diff --git a/Source/DoxygenTranslator/src/DoxygenParser.cpp b/Source/DoxygenTranslator/src/DoxygenParser.cpp
index baa453836..e9425b370 100644
--- a/Source/DoxygenTranslator/src/DoxygenParser.cpp
+++ b/Source/DoxygenTranslator/src/DoxygenParser.cpp
@@ -27,7 +27,7 @@ DoxygenParser::DoxyCommandsMap DoxygenParser::doxygenCommands;
std::set DoxygenParser::doxygenSectionIndicators;
const int TOKENSPERLINE = 8; //change this to change the printing behaviour of the token list
-
+const std::string END_HTML_TAG_MARK("/");
DoxygenParser::DoxygenParser(bool noisy) : noisy(noisy)
{
@@ -76,11 +76,11 @@ void DoxygenParser::fillTables() {
for (int i = 0; i < commandUniquesSize; i++)
doxygenCommands[commandUniques[i]] = COMMANDUNIQUE;
- for (int i = 0; i < htmlCommandsSize; i++)
- doxygenCommands[htmlCommands[i]] = COMMANDUNIQUE;
+ for (int i = 0; i < commandHtmlSize; i++)
+ doxygenCommands[commandHtml[i]] = COMMAND_HTML;
- for (int i = 0; i < commandUniquesSize; i++)
- doxygenCommands[commandUniques[i]] = COMMANDUNIQUE;
+ for (int i = 0; i < commandHtmlEntitiesSize; i++)
+ doxygenCommands[commandHtmlEntities[i]] = COMMAND_HTML_ENTITY;
// fill section indicators command set
for (int i = 0; i < sectionIndicatorsSize; i++)
@@ -575,6 +575,32 @@ int DoxygenParser::addCommandErrorThrow(const std::string &theCommand,
}
+int DoxygenParser::addCommandHtml(const std::string &theCommand,
+ const TokenList &,
+ DoxygenEntityList &doxyList)
+{
+ if (noisy)
+ cout << "Parsing " << theCommand << endl;
+
+ std::string htmlTagArgs = getNextWord();
+ doxyList.push_back(DoxygenEntity(theCommand, htmlTagArgs));
+ return 1;
+}
+
+
+int DoxygenParser::addCommandHtmlEntity(const std::string &theCommand,
+ const TokenList &,
+ DoxygenEntityList &doxyList)
+{
+ if (noisy)
+ cout << "Parsing " << theCommand << endl;
+
+ DoxygenEntityList aNewList;
+ doxyList.push_back(DoxygenEntity(theCommand, aNewList));
+ return 1;
+}
+
+
int DoxygenParser::addCommandUnique(const std::string &theCommand,
const TokenList &tokList,
DoxygenEntityList &doxyList) {
@@ -893,6 +919,10 @@ int DoxygenParser::addCommand(const std::string &commandString,
return addCommandErrorThrow(theCommand, tokList, doxyList);
case COMMANDUNIQUE:
return addCommandUnique(theCommand, tokList, doxyList);
+ case COMMAND_HTML:
+ return addCommandHtml(theCommand, tokList, doxyList);
+ case COMMAND_HTML_ENTITY:
+ return addCommandHtmlEntity(theCommand, tokList, doxyList);
}
return 0;
}
@@ -1068,10 +1098,11 @@ bool DoxygenParser::isStartOfDoxyCommentChar(char c)
}
-void DoxygenParser::addDoxyCommand(DoxygenParser::TokenList &tokList,
+bool DoxygenParser::addDoxyCommand(DoxygenParser::TokenList &tokList,
const std::string &cmd) {
if (findCommand(cmd)) {
tokList.push_back(Token(COMMAND, cmd));
+ return true;
} else {
// Unknown commands are ignored, because they are
// also ignored by Doxygen - see test doxygen_misc_constructs.h, f. backslashB().
@@ -1079,6 +1110,8 @@ void DoxygenParser::addDoxyCommand(DoxygenParser::TokenList &tokList,
// the line below to put unknown commands to output.
// tokList.push_back(Token(PLAINSTRING, cmd));
}
+
+ return false;
}
@@ -1156,21 +1189,58 @@ size_t DoxygenParser::processNormalComment(size_t pos, const std::string &line)
// whitespaces are stored as plain strings
size_t startOfNextWordPos = line.find_first_not_of(" \t", pos + 1);
m_tokenList.push_back(Token(PLAINSTRING,
- line.substr(pos, startOfNextWordPos - pos)));
+ line.substr(pos, startOfNextWordPos - pos)));
pos = startOfNextWordPos;
} break;
case '<': { // process html commands
+ bool isEndHtmlTag = false;
+ pos++;
+ if (line.size() > pos && line[pos] == '/') {
+ isEndHtmlTag = true;
+ pos++;
+ }
- size_t endHtmlPos = line.find_first_of("\t >", pos + 1);
- if (endHtmlPos != string::npos) {
- // will push plain string Token. If the command is not HTML supported by
- // Doxygen, < and > will be replaced by HTML entities < and > respectively,
+ size_t endHtmlPos = line.find_first_of("\t\n >", pos);
+
+ // prepend '<' to distinguish HTML tags from doxygen commands
+ string cmd = line.substr(pos, endHtmlPos - pos);
+ pos = endHtmlPos;
+
+ if (addDoxyCommand(m_tokenList, '<' + cmd)) {
+ // it is a valid HTML command
+ if (line[pos] != '>') { // it should be HTML tag with args,
+ // for example , ![]()
, ...
+ if (isEndHtmlTag) {
+ m_tokenListIt = m_tokenList.end();
+ printListError(WARN_DOXYGEN_COMMAND_ERROR, "Illegal end HTML tag without '>' found! Tag: " + cmd);
+ }
+ endHtmlPos = line.find(">", pos);
+ if (endHtmlPos == string::npos) {
+ m_tokenListIt = m_tokenList.end();
+ printListError(WARN_DOXYGEN_COMMAND_ERROR, "HTML tag without '>' found! Tag: " + cmd);
+ }
+ // add args of HTML command, like link URL, image URL, ...
+ m_tokenList.push_back(Token(PLAINSTRING,
+ line.substr(pos, endHtmlPos - pos)));
+ } else {
+ if (isEndHtmlTag) {
+ // it is a simple tag, so push empty string
+ m_tokenList.push_back(Token(PLAINSTRING, END_HTML_TAG_MARK));
+ } else {
+ // it is a simple tag, so push empty string
+ m_tokenList.push_back(Token(PLAINSTRING, ""));
+ }
+ }
+ } else {
+ // the command is not HTML supported by Doxygen, < and > will be
+ // replaced by HTML entities < and > respectively,
// but only if 'htmlOnly' flag == false. The flag is set/reset by \htmlonly \verbatim,
// \endhtmlonly \endverbatim Doxygen commands.
- // handleHTMLCommand(line.substr(pos + 1), endHtmlPos - pos - 1);
+ m_tokenList.push_back(Token(PLAINSTRING, "<"));
+ m_tokenList.push_back(Token(PLAINSTRING, cmd));
}
- pos = endHtmlPos;
+ pos++;
} break;
case '&': { // process HTML entities
@@ -1190,6 +1260,7 @@ size_t DoxygenParser::processNormalComment(size_t pos, const std::string &line)
}
break;
default:
+ m_tokenListIt = m_tokenList.end();
printListError(WARN_DOXYGEN_COMMAND_ERROR, "Unknown special character: " + line[pos]);
}
diff --git a/Source/DoxygenTranslator/src/DoxygenParser.h b/Source/DoxygenTranslator/src/DoxygenParser.h
index 019da8785..3417a59f4 100644
--- a/Source/DoxygenTranslator/src/DoxygenParser.h
+++ b/Source/DoxygenTranslator/src/DoxygenParser.h
@@ -33,6 +33,8 @@ private:
COMMANDOWORD,
COMMANDERRORTHROW,
COMMANDUNIQUE,
+ COMMAND_HTML,
+ COMMAND_HTML_ENTITY,
END_LINE,
PARAGRAPH_END,
PLAINSTRING,
@@ -299,23 +301,31 @@ private:
* "dir", "file", "cond"
*/
int addCommandOWord(const std::string &theCommand,
- const TokenList &tokList,
- DoxygenEntityList &doxyList);
+ const TokenList &tokList,
+ DoxygenEntityList &doxyList);
/*
* Commands that should not be encountered (such as PHP only)
* goes til the end of line then returns
*/
int addCommandErrorThrow(const std::string &theCommand,
- const TokenList &tokList,
- DoxygenEntityList &doxyList);
+ const TokenList &tokList,
+ DoxygenEntityList &doxyList);
+
+ int addCommandHtml(const std::string &theCommand,
+ const TokenList &tokList,
+ DoxygenEntityList &doxyList);
+
+ int addCommandHtmlEntity(const std::string &theCommand,
+ const TokenList &tokList,
+ DoxygenEntityList &doxyList);
/*
*Adds the unique commands- different process for each unique command
*/
int addCommandUnique(const std::string &theCommand,
- const TokenList &tokList,
- DoxygenEntityList &doxyList);
+ const TokenList &tokList,
+ DoxygenEntityList &doxyList);
/*
* The actual "meat" of the doxygen parser. Calls the correct addCommand...()
@@ -351,7 +361,7 @@ private:
StringVector split(const std::string &text, char separator);
bool isStartOfDoxyCommentChar(char c);
- void addDoxyCommand(DoxygenParser::TokenList &tokList, const std::string &cmd);
+ bool addDoxyCommand(DoxygenParser::TokenList &tokList, const std::string &cmd);
public:
DoxygenParser(bool noisy = false);
diff --git a/Source/DoxygenTranslator/src/JavaDocConverter.cpp b/Source/DoxygenTranslator/src/JavaDocConverter.cpp
index c94999e33..2a02af348 100644
--- a/Source/DoxygenTranslator/src/JavaDocConverter.cpp
+++ b/Source/DoxygenTranslator/src/JavaDocConverter.cpp
@@ -147,6 +147,10 @@ void JavaDocConverter::fillStaticTables() {
tagHandlers["plainstd::string"] = make_pair(&JavaDocConverter::handlePlainString, "");
tagHandlers["plainstd::endl"] = make_pair(&JavaDocConverter::handleNewLine, "");
tagHandlers["n"] = make_pair(&JavaDocConverter::handleNewLine, "");
+
+ // HTML tags
+ tagHandlers["*(it->second.first))(tag, translatedComment, it->second.second);
+ } else {
+ addError(WARN_DOXYGEN_COMMAND_ERROR, "Unknown doxygen or HTML tag: " + tag.typeOfEntity);
}
}
@@ -285,6 +291,17 @@ void JavaDocConverter::handleTagHtml(DoxygenEntity& tag, std::string& translated
}
+void JavaDocConverter::handleDoxyHtmlTag(DoxygenEntity& tag, std::string& translatedComment, std::string &arg) {
+ std::string htmlTagArgs = tag.data;
+ if (htmlTagArgs == "/") {
+ // end html tag, for example "
+ translatedComment += "";
+ } else {
+ translatedComment += arg + htmlTagArgs + ">";
+ }
+}
+
+
void JavaDocConverter::handleNewLine(DoxygenEntity&, std::string& translatedComment, std::string&) {
translatedComment += "\n * ";
}
@@ -704,3 +721,10 @@ String *JavaDocConverter::makeDocumentation(Node *node) {
return NewString(javaDocString.c_str());
}
+
+
+void JavaDocConverter::addError(int warningType,
+ const std::string &message) {
+ Swig_warning(warningType, "", 0,
+ "Doxygen parser warning: %s. \n", message.c_str());
+}
diff --git a/Source/DoxygenTranslator/src/JavaDocConverter.h b/Source/DoxygenTranslator/src/JavaDocConverter.h
index 2c3ac72f0..1d757cf35 100644
--- a/Source/DoxygenTranslator/src/JavaDocConverter.h
+++ b/Source/DoxygenTranslator/src/JavaDocConverter.h
@@ -60,6 +60,12 @@ protected:
* arg - html tag, with no braces
*/
void handleTagHtml(DoxygenEntity &tag, std::string &translatedComment, std::string &arg);
+
+ /* Handles HTML tags recognized by Doxygen, like , , , ... */
+ void handleDoxyHtmlTag(DoxygenEntity& tag,
+ std::string& translatedComment,
+ std::string &arg);
+
/*
* Just prints new line
*/
@@ -128,6 +134,8 @@ private:
bool paramExists(std::string param);
std::string indentAndInsertAsterisks(const std::string &doc);
+
+ void addError(int warningType, const std::string &message);
};
#endif