No changes, just spelling fixes in Doxygen branch changes.
Most are just typos, but also s/JavaDoc/Javadoc/ and s/PythonDoc/Pydoc/ as this is how they are officially called.
This commit is contained in:
parent
c6ef433b9b
commit
5c0ed6c635
5 changed files with 64 additions and 64 deletions
|
|
@ -45,7 +45,7 @@ void DoxygenParser::fillTables()
|
|||
if (doxygenCommands.size())
|
||||
return;
|
||||
|
||||
// fill in tables with data from DxygenCommands.h
|
||||
// fill in tables with data from DoxygenCommands.h
|
||||
for (int i = 0; i < simpleCommandsSize; i++)
|
||||
doxygenCommands[simpleCommands[i]] = SIMPLECOMMAND;
|
||||
|
||||
|
|
|
|||
|
|
@ -50,12 +50,12 @@ void JavaDocConverter::fillStaticTables()
|
|||
* Java src is <x> and therefore invisible on output - browser ignores unknown command.
|
||||
* This is handy in syntax descriptions, for example: more <fileName>.
|
||||
*
|
||||
* Standlaone < and > need not be translated, they are rendered properly in
|
||||
* Standalone < and > need not be translated, they are rendered properly in
|
||||
* all three outputs.
|
||||
*
|
||||
* ., %, and " need not to be translated
|
||||
*
|
||||
* entities must be translated - remain in Java, something meaningfull in Python (<, ...)
|
||||
* entities must be translated - remain in Java, something meaningful in Python (<, ...)
|
||||
*
|
||||
* - Python
|
||||
* - add comments also to auto-generated methods like equals(), delete() in Java,
|
||||
|
|
@ -419,7 +419,7 @@ void JavaDocConverter::handleTagHtml(DoxygenEntity& tag,
|
|||
{
|
||||
if (tag.entityList.size()) { // do not include empty tags
|
||||
std::string tagData = translateSubtree(tag);
|
||||
// wrap the thing, ignoring whitespaces
|
||||
// wrap the thing, ignoring whitespace
|
||||
size_t wsPos = tagData.find_last_not_of("\n\t ");
|
||||
if (wsPos != std::string::npos)
|
||||
translatedComment += "<" + arg + ">" + tagData.substr(0, wsPos + 1) + "</"
|
||||
|
|
@ -791,7 +791,7 @@ void JavaDocConverter::handleTagSee(DoxygenEntity& tag,
|
|||
translatedComment += linkObject;
|
||||
}
|
||||
|
||||
/* This function moves all endlines at the end of child entities
|
||||
/* This function moves all line endings at the end of child entities
|
||||
* out of the child entities to the parent.
|
||||
* For example, entity tree:
|
||||
|
||||
|
|
@ -812,7 +812,7 @@ int JavaDocConverter::shiftEndlinesUpTree(DoxygenEntity &root, int level)
|
|||
{
|
||||
DoxygenEntityListIt it = root.entityList.begin();
|
||||
while (it != root.entityList.end()) {
|
||||
// remove endlines
|
||||
// remove line endings
|
||||
int ret = shiftEndlinesUpTree(*it, level + 1);
|
||||
// insert them after this element
|
||||
it++;
|
||||
|
|
@ -948,7 +948,7 @@ String *JavaDocConverter::makeDocumentation(Node *node)
|
|||
|
||||
shiftEndlinesUpTree(root);
|
||||
|
||||
// strip endlines at the beginning
|
||||
// strip line endings at the beginning
|
||||
while (!root.entityList.empty()
|
||||
&& root.entityList.begin()->typeOfEntity == "plainstd::endl") {
|
||||
root.entityList.pop_front();
|
||||
|
|
|
|||
|
|
@ -442,7 +442,7 @@ void PyDocConverter::handleTagWrap(DoxygenEntity& tag,
|
|||
{
|
||||
if (tag.entityList.size()) { // do not include empty tags
|
||||
std::string tagData = translateSubtree(tag);
|
||||
// wrap the thing, ignoring whitespaces
|
||||
// wrap the thing, ignoring whitespace
|
||||
size_t wsPos = tagData.find_last_not_of("\n\t ");
|
||||
if (wsPos != std::string::npos && wsPos != tagData.size() - 1)
|
||||
translatedComment += arg + tagData.substr(0, wsPos + 1) + arg
|
||||
|
|
|
|||
|
|
@ -36,7 +36,7 @@ protected:
|
|||
|
||||
/*
|
||||
* Format a string so it is justified and split over several lines
|
||||
* not exeeding a given length.
|
||||
* not exceeding a given length.
|
||||
*/
|
||||
std::string justifyString(std::string unformattedLine, int indent = 0, int maxWidth = DOC_STRING_LENGTH);
|
||||
/*
|
||||
|
|
@ -46,7 +46,7 @@ protected:
|
|||
*/
|
||||
std::string translateSubtree(DoxygenEntity & doxygenEntity);
|
||||
/*
|
||||
* Translate one entity with the appropriate handler, acording
|
||||
* Translate one entity with the appropriate handler, according
|
||||
* to the tagHandlers
|
||||
*/
|
||||
void translateEntity(DoxygenEntity & doxyEntity, std::string &translatedComment);
|
||||
|
|
@ -117,14 +117,14 @@ protected:
|
|||
|
||||
void handleDoxyHtmlTag(DoxygenEntity& tag, std::string& translatedComment, std::string &arg);
|
||||
|
||||
/** Does not ouput params of HTML tag, for example in <table border='1'>
|
||||
/** Does not output params of HTML tag, for example in <table border='1'>
|
||||
* 'border=1' is not written to output.
|
||||
*/
|
||||
void handleDoxyHtmlTagNoParam(DoxygenEntity& tag,
|
||||
std::string& translatedComment,
|
||||
std::string &arg);
|
||||
|
||||
/** TRanslates tag <a href = "url">text</a> to: text ("url"). */
|
||||
/** Translates tag <a href = "url">text</a> to: text ("url"). */
|
||||
void handleDoxyHtmlTag_A(DoxygenEntity& tag,
|
||||
std::string& translatedComment,
|
||||
std::string &arg);
|
||||
|
|
@ -170,7 +170,7 @@ private:
|
|||
Node *currentNode;
|
||||
// this contains the handler pointer and one string argument
|
||||
static std::map<std::string, std::pair<tagHandler, std::string> > tagHandlers;
|
||||
// this cointains the sectins titiles, like 'Arguments:' or 'Notes:', that are printed only once
|
||||
// this contains the sections tittles, like 'Arguments:' or 'Notes:', that are printed only once
|
||||
static std::map<std::string, std::string> sectionTitles;
|
||||
void fillStaticTables();
|
||||
};
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue