#include <stdio.h>#include <qlist.h>#include <qstrlist.h>#include <qstring.h>#include "docvisitor.h"#include "htmlattrib.h"Go to the source code of this file.
Classes | |
| class | DocNode |
| Abstract node interface with type information. More... | |
| class | CompAccept< T > |
| Default accept implementation for compound nodes in the abstract syntax tree. More... | |
| class | DocWord |
| Node representing a word. More... | |
| class | DocLinkedWord |
| Node representing a word that can be linked to something. More... | |
| class | DocURL |
| Node representing an URL (or email address). More... | |
| class | DocLineBreak |
| Node representing a line break. More... | |
| class | DocHorRuler |
| Node representing a horizonal ruler. More... | |
| class | DocAnchor |
| Node representing an anchor. More... | |
| class | DocStyleChange |
| Node representing a style change. More... | |
| class | DocSymbol |
| Node representing a special symbol. More... | |
| class | DocWhiteSpace |
| Node representing some amount of white space. More... | |
| class | DocVerbatim |
| Node representing a verbatim, unparsed text fragment. More... | |
| class | DocInclude |
| Node representing an included text block from file. More... | |
| class | DocIncOperator |
| Node representing a include/dontinclude operator block. More... | |
| class | DocFormula |
| Node representing an item of a cross-referenced list. More... | |
| class | DocIndexEntry |
| Node representing an entry in the index. More... | |
| class | DocCopy |
| Node representing a entry in the index. More... | |
| class | DocAutoList |
| Node representing an auto List. More... | |
| class | DocTitle |
| Node representing a simple section title. More... | |
| class | DocXRefItem |
| Node representing an item of a cross-referenced list. More... | |
| class | DocImage |
| Node representing an image. More... | |
| class | DocDotFile |
| Node representing a dot file. More... | |
| class | DocLink |
| Node representing a link to some item. More... | |
| class | DocRef |
| Node representing a reference to some item. More... | |
| class | DocInternalRef |
| Node representing an internal reference to some item. More... | |
| class | DocHRef |
| Node representing a Language specific section Node representing a Hypertext reference. More... | |
| class | DocHtmlHeader |
| Node Html heading. More... | |
| class | DocHtmlDescTitle |
| Node representing a Html description item. More... | |
| class | DocHtmlDescList |
| Node representing a Html description list. More... | |
| class | DocSection |
| Node representing a normal section. More... | |
| class | DocSecRefItem |
| Node representing a reference to a section. More... | |
| class | DocSecRefList |
| Node representing a list of section references. More... | |
| class | DocInternal |
| Node representing an internal section of documentation. More... | |
| class | DocSimpleList |
| Node representing a simple list. More... | |
| class | DocHtmlList |
| Node representing a Html list. More... | |
| class | DocSimpleSect |
| class | DocParamSect |
| class | DocPara |
| class | DocParamList |
| Node representing a parameter list. More... | |
| class | DocAutoListItem |
| Node representing an item of a auto list. More... | |
| class | DocSimpleListItem |
| Node representing a simple list item. More... | |
| class | DocHtmlListItem |
| Node representing a HTML list item. More... | |
| class | DocHtmlDescData |
| Node representing a HTML description data. More... | |
| class | DocHtmlCell |
| Node representing a HTML table cell. More... | |
| class | DocHtmlCaption |
| Node representing a HTML table caption. More... | |
| class | DocHtmlRow |
| Node representing a HTML table row. More... | |
| class | DocHtmlTable |
| Node representing a HTML table. More... | |
| class | DocText |
| Root node of a text fragment. More... | |
| class | DocRoot |
| Root node of documentation tree. More... | |
Functions | |
| void | initDocParser () |
| void | finializeDocParser () |
| DocNode * | validatingParseDoc (const char *fileName, int startLine, Definition *context, MemberDef *md, const char *input, bool indexWords, bool isExample, const char *exampleName=0, bool singleLine=FALSE, bool linkFromIndex=FALSE) |
| DocNode * | validatingParseText (const char *input) |
| void | docFindSections (const char *input, Definition *d, MemberGroup *m, const char *fileName) |
| void docFindSections | ( | const char * | input, | |
| Definition * | d, | |||
| MemberGroup * | m, | |||
| const char * | fileName | |||
| ) |
Searches for section and anchor commands in the input
Definition at line 6202 of file docparser.cpp.
References doctokenizerYYFindSections().
Referenced by ClassDef::findSectionsInDocumentation(), FileDef::findSectionsInDocumentation(), GroupDef::findSectionsInDocumentation(), MemberDef::findSectionsInDocumentation(), MemberGroup::findSectionsInDocumentation(), NamespaceDef::findSectionsInDocumentation(), and PageDef::findSectionsInDocumentation().
| void finializeDocParser | ( | ) |
Cleanup the documentation parser
Definition at line 6222 of file docparser.cpp.
References Doxygen::searchIndex.
Referenced by generateOutput().
| void initDocParser | ( | ) |
Initialize the documentation parser
Definition at line 6210 of file docparser.cpp.
References Config_getBool, and Doxygen::searchIndex.
Referenced by generateOutput().
| DocNode* validatingParseDoc | ( | const char * | fileName, | |
| int | startLine, | |||
| Definition * | context, | |||
| MemberDef * | md, | |||
| const char * | input, | |||
| bool | indexWords, | |||
| bool | isExample, | |||
| const char * | exampleName = 0, |
|||
| bool | singleLine = FALSE, |
|||
| bool | linkFromIndex = FALSE | |||
| ) |
Main entry point for the documentation parser.
| fileName | File in which the documentation block is found (or the name of the example file in case isExample is TRUE). | |
| startLine | Line at which the documentation block is found. | |
| context | Class or namespace to which this block belongs. | |
| md | Member definition to which the documentation belongs. Can be 0. | |
| input | String representation of the documentation block. | |
| indexWords | Indicates whether or not words should be put in the search index. | |
| isExample | TRUE if the documentation belongs to an example. | |
| exampleName | Base name of the example file (0 if isExample is FALSE). | |
| singleLine | Output should be presented on a single line, so without starting a new paragraph at the end. | |
| linkFromIndex | TRUE if the documentation is generated from an index page. In this case context is not used to determine the relative path when making a link. |
Definition at line 5979 of file docparser.cpp.
References DocRoot::accept(), MemberDef::anchor, ClassDef::compoundTypeString(), Config_getBool, DefinitionIntf::definitionType(), doctokenizerYYinit(), doctokenizerYYlineno, Definition::getOutputFileBase(), MemberDef::getOutputFileBase(), GroupDef::groupTitle(), Debug::isFlagSet(), Definition::name(), DocRoot::parse(), Debug::PrintTree, QCString, Definition::qualifiedName(), MemberDef::qualifiedName(), relativePathToRoot(), Doxygen::searchIndex, SearchIndex::setCurrentDoc(), substitute(), theTranslator, PageDef::title(), Translator::trGroup(), Translator::trMember(), Translator::trModule(), Translator::trNamespace(), Translator::trPackage(), Translator::trPage(), Translator::trSubprogram(), DefinitionIntf::TypeClass, DefinitionIntf::TypeGroup, DefinitionIntf::TypeNamespace, and DefinitionIntf::TypePage.
Referenced by parseCommentAsText(), and OutputList::parseDoc().
| DocNode* validatingParseText | ( | const char * | input | ) |
Main entry point for parsing simple text fragments. These fragments are limited to words, whitespace and symbols.
Definition at line 6150 of file docparser.cpp.
References DocText::accept(), doctokenizerYYinit(), doctokenizerYYlineno, Debug::isFlagSet(), DocText::parse(), and Debug::PrintTree.
Referenced by OutputList::parseText().
1.5.1