diff --git a/Source/DoxygenTranslator/src/DoxygenTranslator.h b/Source/DoxygenTranslator/src/DoxygenTranslator.h index 7d2e64542..1b90dbc43 100644 --- a/Source/DoxygenTranslator/src/DoxygenTranslator.h +++ b/Source/DoxygenTranslator/src/DoxygenTranslator.h @@ -38,8 +38,6 @@ public: /* * Return the documentation for a given node formated for the correct * documentation system. - * @param node The node to extract and translate documentation for. - * @return The resulted documentation string, or empty string in case of any errors. */ String *getDocumentation(Node *node); /* @@ -56,8 +54,6 @@ protected: /* * Overridden in subclasses to return the documentation formatted for a given * documentation system. - * @param node The node to extract and translate documentation for. - * @return The resulted documentation string */ virtual String *makeDocumentation(Node *node) = 0; diff --git a/Source/DoxygenTranslator/src/JavaDocConverter.h b/Source/DoxygenTranslator/src/JavaDocConverter.h index 752bb9b5f..cad228038 100644 --- a/Source/DoxygenTranslator/src/JavaDocConverter.h +++ b/Source/DoxygenTranslator/src/JavaDocConverter.h @@ -26,8 +26,18 @@ public: String *makeDocumentation(Node *node); protected: + /* + * Used to properly format JavaDoc-style command + */ std::string formatCommand(std::string unformattedLine, int indent); + /* + * Translate every entity in a tree. + */ std::string translateSubtree(DoxygenEntity & doxygenEntity); + /* + * Translate one entity with the appropriate handler, acording + * to the tagHandlers + */ void translateEntity(DoxygenEntity &tag, std::string &translatedComment); /* * Fix all endlines location, etc @@ -95,7 +105,7 @@ protected: */ void handleTagPar(DoxygenEntity &tag, std::string &translatedComment, std::string &arg); /* - * Insert @param command, if it is really a function param + * Insert \@param command, if it is really a function param */ void handleTagParam(DoxygenEntity &tag, std::string &translatedComment, std::string &arg); /* diff --git a/Source/DoxygenTranslator/src/PyDocConverter.h b/Source/DoxygenTranslator/src/PyDocConverter.h index 6094b4100..ee4d436c3 100644 --- a/Source/DoxygenTranslator/src/PyDocConverter.h +++ b/Source/DoxygenTranslator/src/PyDocConverter.h @@ -32,9 +32,6 @@ protected: /* * Format a string so it is justified and split over several lines * not exeeding a given length. - * @param unformattedLine The string to justify and split. - * @param indent An optional number of spaces to indent each line by. - * @param maxWidth The approximate maximum line width. */ std::string justifyString(std::string unformattedLine, int indent = 0, int maxWidth = DOC_STRING_LENGTH); /*