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

Fixed comments in the source code

Browse source 
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/branches/gsoc2012-doxygen@13668 626c5289-ae23-0410-ae9c-e8d60b6d4f22
This commit is contained in:
Dmitry Kabak 2012-08-19 14:42:26 +00:00
commit 549b2046b1
3 changed files with 11 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

4
Source/DoxygenTranslator/src/DoxygenTranslator.h
View file

@ -38,8 +38,6 @@ public:
/* /*
* Return the documentation for a given node formated for the correct * Return the documentation for a given node formated for the correct
* documentation system. * 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); String *getDocumentation(Node *node);
/* /*
@ -56,8 +54,6 @@ protected:
/* /*
* Overridden in subclasses to return the documentation formatted for a given * Overridden in subclasses to return the documentation formatted for a given
* documentation system. * documentation system.
* @param node The node to extract and translate documentation for.
* @return The resulted documentation string
*/ */
virtual String *makeDocumentation(Node *node) = 0; virtual String *makeDocumentation(Node *node) = 0;

12
Source/DoxygenTranslator/src/JavaDocConverter.h
View file

@ -26,8 +26,18 @@ public:
String *makeDocumentation(Node *node); String *makeDocumentation(Node *node);
protected: protected:
/*
* Used to properly format JavaDoc-style command
*/
std::string formatCommand(std::string unformattedLine, int indent); std::string formatCommand(std::string unformattedLine, int indent);
/*
* Translate every entity in a tree.
*/
std::string translateSubtree(DoxygenEntity & doxygenEntity); std::string translateSubtree(DoxygenEntity & doxygenEntity);
/*
* Translate one entity with the appropriate handler, acording
* to the tagHandlers
*/
void translateEntity(DoxygenEntity &tag, std::string &translatedComment); void translateEntity(DoxygenEntity &tag, std::string &translatedComment);
/* /*
* Fix all endlines location, etc * Fix all endlines location, etc
@ -95,7 +105,7 @@ protected:
*/ */
void handleTagPar(DoxygenEntity &tag, std::string &translatedComment, std::string &arg); 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); void handleTagParam(DoxygenEntity &tag, std::string &translatedComment, std::string &arg);
/* /*

3
Source/DoxygenTranslator/src/PyDocConverter.h
View file

@ -32,9 +32,6 @@ protected:
/* /*
* Format a string so it is justified and split over several lines * Format a string so it is justified and split over several lines
* not exeeding a given length. * 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); std::string justifyString(std::string unformattedLine, int indent = 0, int maxWidth = DOC_STRING_LENGTH);
/* /*