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

Get rid of meaningless return type of DoxygenParser methods

Browse source 
The return value of methods handling various Doxygen commands was never
actually used, so just get rid of it and don't return anything, this makes the
code slightly simpler without any change of functionality.

It also makes the question about why all these functions return "int" (which
should have been "bool" from the beginning) obsolete.
This commit is contained in:
Vadim Zeitlin 2017-02-01 01:53:31 +01:00
commit 4e7dad2b76
2 changed files with 122 additions and 115 deletions
Download patch file Download diff file Expand all files Collapse all files

30
Source/DoxygenTranslator/src/DoxygenParser.h
View file

@ -240,7 +240,7 @@ private:
* Plain commands, such as newline etc, they contain no other data
* \n \\ \@ \& \$ \# \< \> \%
*/
int addSimpleCommand(const std::string &theCommand,
void addSimpleCommand(const std::string &theCommand,
DoxygenEntityList &doxyList);
/*
* CommandWord
@ -250,7 +250,7 @@ private:
* "relates", "namespace", "relatesalso","anchor", "dontinclude", "include",
* "includelineno"
*/
int addCommandWord(const std::string &theCommand,
void addCommandWord(const std::string &theCommand,
const TokenList &tokList,
DoxygenEntityList &doxyList);
/*
@ -260,7 +260,7 @@ private:
* "addindex", "fn", "name", "line", "var", "skipline", "typedef", "skip",
* "until", "property"
*/
int addCommandLine(const std::string &theCommand,
void addCommandLine(const std::string &theCommand,
const TokenList &tokList,
DoxygenEntityList &doxyList);
/*
@ -271,7 +271,7 @@ private:
* "details", "invariant", "deprecated", "date", "note", "warning",
* "version", "todo", "bug", "attention", "brief", "arg", "author"
*/
int addCommandParagraph(const std::string &theCommand,
void addCommandParagraph(const std::string &theCommand,
const TokenList &tokList,
DoxygenEntityList &doxyList);
/*
@ -283,7 +283,7 @@ private:
* "link"
* Returns 1 if success, 0 if the endcommand is never encountered.
*/
int addCommandEndCommand(const std::string &theCommand,
void addCommandEndCommand(const std::string &theCommand,
const TokenList & tokList,
DoxygenEntityList &doxyList);
/*
@ -292,7 +292,7 @@ private:
* Commands such as param
* "param", "tparam", "throw", "throws", "retval", "exception"
*/
int addCommandWordParagraph(const std::string &theCommand,
void addCommandWordParagraph(const std::string &theCommand,
const TokenList & tokList,
DoxygenEntityList &doxyList);
/*
@ -301,7 +301,7 @@ private:
* Commands such as param
* "page", "subsection", "subsubsection", "section", "paragraph", "defgroup"
*/
int addCommandWordLine(const std::string &theCommand,
void addCommandWordLine(const std::string &theCommand,
const TokenList &tokList,
DoxygenEntityList &doxyList);
/*
@ -310,7 +310,7 @@ private:
* Commands such as class
* "category", "class", "protocol", "interface", "struct", "union"
*/
int addCommandWordOWordOWord(const std::string &theCommand,
void addCommandWordOWordOWord(const std::string &theCommand,
const TokenList &tokList,
DoxygenEntityList &doxyList);
/*
@ -319,7 +319,7 @@ private:
* Commands such as dir
* "dir", "file", "cond"
*/
int addCommandOWord(const std::string &theCommand,
void addCommandOWord(const std::string &theCommand,
const TokenList &tokList,
DoxygenEntityList &doxyList);
@ -327,22 +327,22 @@ private:
* Commands that should not be encountered (such as PHP only)
* goes til the end of line then returns
*/
int addCommandErrorThrow(const std::string &theCommand,
void addCommandErrorThrow(const std::string &theCommand,
const TokenList &tokList,
DoxygenEntityList &doxyList);
int addCommandHtml(const std::string &theCommand,
void addCommandHtml(const std::string &theCommand,
const TokenList &tokList,
DoxygenEntityList &doxyList);
int addCommandHtmlEntity(const std::string &theCommand,
void 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,
void addCommandUnique(const std::string &theCommand,
const TokenList &tokList,
DoxygenEntityList &doxyList);
@ -350,7 +350,7 @@ private:
* Simply ignore the given command, possibly with the word following it or
* until the matching end command.
*/
int ignoreCommand(const std::string& theCommand,
void ignoreCommand(const std::string& theCommand,
const TokenList &tokList,
DoxygenEntityList &doxyList);
@ -358,7 +358,7 @@ private:
* The actual "meat" of the doxygen parser. Calls the correct addCommand...()
* function.
*/
int addCommand(const std::string &commandString,
void addCommand(const std::string &commandString,
const TokenList &tokList,
DoxygenEntityList &doxyList);