Doxygen
Loading...
Searching...
No Matches
Classes | Macros | Typedefs | Functions | Variables
docnode.cpp File Reference
#include "docnode.h"
#include "docparser_p.h"
#include "htmlentity.h"
#include "configimpl.h"
#include "configoptions.h"
#include "emoji.h"
#include "message.h"
#include "doxygen.h"
#include "cite.h"
#include "util.h"
#include "formula.h"
#include "markdown.h"
#include "pagedef.h"
#include "namespacedef.h"
#include "groupdef.h"
#include "cmdmapper.h"
#include "config.h"
#include "vhdldocgen.h"
#include "doctokenizer.h"
#include "plantuml.h"
#include "language.h"
#include "datetime.h"
#include "trace.h"
#include "anchor.h"
#include "aliases.h"
+ Include dependency graph for docnode.cpp:

Go to the source code of this file.

Classes

struct  ActiveRowSpan
 Helper class to compute the grid for an HTML style table. More...
 

Macros

#define AUTO_TRACE(...)
 
#define AUTO_TRACE_ADD(...)
 
#define AUTO_TRACE_EXIT(...)
 
#define INTERNAL_ASSERT(x)
 

Typedefs

typedef std::vector< ActiveRowSpan > RowSpanList
 List of ActiveRowSpan classes.
 

Functions

static void unescapeCRef (QCString &s)
 
static QCString stripKnownExtensions (const QCString &text)
 
static void setParent (DocNodeVariant *n, DocNodeVariant *newParent)
 
static void flattenParagraphs (DocNodeVariant *root, DocNodeList &children)
 
static bool findAttribute (const HtmlAttribList &tagHtmlAttribs, const char *attrName, QCString *result)
 
static bool checkIfHtmlEndTagEndsAutoList (DocParser *parser, const DocNodeVariant *n)
 

Variables

static const char * g_sectionLevelToName []
 
static const StringUnorderedSet g_plantumlEngine
 

Macro Definition Documentation

◆ AUTO_TRACE

#define AUTO_TRACE ( ...)
Value:
(void)0

Definition at line 46 of file docnode.cpp.

Referenced by MemberDefImpl::_computeLinkableInProject(), SymbolResolver::Private::accessibleViaUsingDefinition(), SymbolResolver::Private::accessibleViaUsingNamespace(), addClassAndNestedClasses(), addClassToContext(), ModuleDefImpl::addClassToModule(), addConceptToContext(), ModuleDefImpl::addConceptToModule(), ModuleManager::addDocs(), addEnumDocs(), addEnumValuesToEnums(), ModuleDefImpl::addExportedModule(), addGlobalFunction(), ModuleDefImpl::addHeader(), ModuleManager::addHeader(), ModuleDefImpl::addImport(), ModuleManager::addImport(), addInterfaceOrServiceToServiceOrSingleton(), addListReferences(), addLocalObjCMethod(), addMemberDocs(), addMemberFunction(), addMemberSpecialization(), ClassDefImpl::addMemberToList(), ModuleDefImpl::addMemberToModule(), addMethodToClass(), Markdown::Private::addStrEscapeUtf8Nbsp(), DirDefImpl::addUsesDependency(), addVariable(), addVariableToClass(), addVariableToFile(), adjustConfiguration(), buildClassDocList(), buildClassList(), buildConceptDocList(), buildConceptList(), buildDefineList(), buildDictionaryList(), buildDirectories(), buildFunctionList(), buildGroupListFiltered(), buildInterfaceAndServiceList(), buildNamespaceList(), buildSequenceList(), buildTypedefList(), buildVarList(), checkConfiguration(), ClassDefImpl::ClassDefImpl(), ModuleManager::collectExportedSymbols(), ModuleManager::collectExportedSymbolsRecursively(), combineDeclarationAndDefinition(), computeClassRelations(), computeCommonDirPrefix(), DirDefImpl::computeDependencies(), computeDirDependencies(), computeIndentExcludingListMarkers(), computeMemberReferences(), computeTemplateClassRelations(), ClassDefImpl::containsOverload(), ModuleManager::createModuleDef(), DirDefImpl::createNewDir(), createUsingMemberImportForClass(), ClassDefImpl::deepCopy(), DocParser::defaultHandleTitleAndSize(), DocParser::defaultHandleToken(), distributeConceptGroups(), DocRef::DocRef(), encodeDirName(), extractCanonicalType(), Markdown::extractPageTitle(), Markdown::Private::extractTitleId(), filterMemberDocumentation(), findBaseClassesForClass(), CodeFragmentManager::Private::FragmentInfo::findBlockMarkers(), findClassRelation(), DocParser::findDocsForMemberOrCompound(), Markdown::Private::findEmphasisChar(), Markdown::Private::findEndOfLine(), findEnumDocumentation(), findEnums(), findFriends(), findFunctionPtr(), findGlobalMember(), findInheritedTemplateInstances(), findMember(), findMemberDocumentation(), findModuleDocumentation(), findObjCMethodDefinitions(), findTableColumns(), findTemplateInstanceRelation(), findUsedClassesForClass(), findUsedTemplateInstances(), findUsingDeclarations(), findUsingDeclImports(), findUsingDirectives(), SymbolResolver::Private::followPath(), generateDirDocs(), generateDocsForClassList(), generateOutput(), generateXRefPages(), getCanonicalTypeForIdentifier(), ClassDefImpl::getOutputFileBase(), DirDefImpl::getOutputFileBase(), SymbolResolver::Private::getResolvedSymbol(), SymbolResolver::Private::getResolvedSymbolRec(), SymbolResolver::Private::getResolvedType(), SymbolResolver::Private::getResolvedTypeRec(), DocParser::handleAHref(), DocParser::handleAnchor(), DocPara::handleCite(), DocPara::handleCommand(), handleCommentBlock(), DocPara::handleEmoji(), DocPara::handleFile(), DocPara::handleHtmlEndTag(), DocPara::handleHtmlHeader(), DocPara::handleHtmlStartTag(), DocPara::handleIFile(), DocPara::handleILine(), DocParser::handleImage(), DocParser::handleImg(), DocPara::handleInclude(), DocPara::handleIncludeOperator(), DocParser::handleInitialStyleCommands(), DocParser::handleInternalRef(), DocPara::handleLink(), DocParser::handleLinkedWord(), handleParametersCommentBlocks(), DocParser::handleParameterType(), DocPara::handleParamSection(), DocParser::handlePendingStyleCommands(), DocParser::handlePrefix(), DocPara::handleRef(), DocPara::handleSection(), DocPara::handleShowDate(), DocPara::handleSimpleSection(), DocPara::handleStartCode(), DocParser::handleStyleArgument(), DocParser::handleStyleEnter(), DocParser::handleStyleLeave(), DocParser::handleUnclosedStyleCommands(), DocPara::handleVhdlFlow(), DocPara::handleXRefItem(), hasLineBreak(), DocPara::injectToken(), ClassDefImpl::insertTemplateInstance(), ClassDefImpl::internalInsertMember(), DocParser::internalValidatingParseDoc(), SymbolResolver::isAccessibleFrom(), SymbolResolver::Private::isAccessibleFrom(), SymbolResolver::isAccessibleFromWithExpScope(), SymbolResolver::Private::isAccessibleFromWithExpScope(), Markdown::Private::isAtxHeader(), Markdown::Private::isBlockCommand(), isBlockQuote(), isCodeBlock(), isEmptyLine(), isEndOfList(), isExplicitPage(), isFencedCodeBlock(), Markdown::Private::isHeaderline(), isHRuler(), isLinkRef(), isListMarker(), Markdown::Private::isSpecialCommand(), isTableBlock(), isVarWithConstructor(), makeTemplateInstanceRelation(), markdownFileNameToId(), matchArgument2(), matchArguments2(), matchCanonicalTypes(), mergeArguments(), mergeCategories(), ClassDefImpl::mergeCategory(), DirDefImpl::mergeDirectoryInTree(), mergeScopes(), ModuleDefImpl::mergeSymbolsFrom(), SymbolResolver::Private::newResolveTypedef(), organizeSubGroupsFiltered(), DocAutoList::parse(), DocAutoListItem::parse(), DocHRef::parse(), DocHtmlBlockQuote::parse(), DocHtmlCaption::parse(), DocHtmlCell::parse(), DocHtmlDescData::parse(), DocHtmlDescList::parse(), DocHtmlDescTitle::parse(), DocHtmlDetails::parse(), DocHtmlHeader::parse(), DocHtmlList::parse(), DocHtmlListItem::parse(), DocHtmlRow::parse(), DocHtmlSummary::parse(), DocHtmlTable::parse(), DocInclude::parse(), DocIncOperator::parse(), DocIndexEntry::parse(), DocInternal::parse(), DocInternalRef::parse(), DocLink::parse(), DocPara::parse(), DocParamList::parse(), DocParamSect::parse(), DocParBlock::parse(), DocRef::parse(), DocRoot::parse(), DocSecRefItem::parse(), DocSecRefList::parse(), DocSection::parse(), DocSimpleSect::parse(), DocText::parse(), DocTitle::parse(), DocVhdlFlow::parse(), CodeFragmentManager::parseCodeFragment(), CommentScanner::parseCommentBlock(), parseCompounds(), parseFile(), parseFilesMultiThreading(), parseFilesSingleThreading(), COutlineParser::parseInput(), parseInput(), parseMain(), parsePrototype(), DocSimpleSect::parseRcs(), DocHtmlDetails::parseSummary(), DocHtmlCell::parseXml(), DocHtmlList::parseXml(), DocHtmlListItem::parseXml(), DocHtmlRow::parseXml(), DocHtmlTable::parseXml(), DocParamList::parseXml(), DocSimpleSect::parseXml(), Markdown::Private::processBlocks(), Markdown::Private::processCodeSpan(), DocParser::processCopyDoc(), Markdown::Private::processEmphasis(), Markdown::Private::processEmphasis1(), Markdown::Private::processEmphasis2(), Markdown::Private::processEmphasis3(), Preprocessor::processFile(), Markdown::Private::processHtmlTag(), Markdown::Private::processHtmlTagWrite(), Markdown::Private::processInline(), Markdown::Private::processLink(), Markdown::Private::processNmdash(), Markdown::Private::processQuotations(), Markdown::Private::processQuoted(), Markdown::Private::processSpecialCommand(), readIncludeFile(), DocParser::readTextFileByName(), readTextFileByName(), SymbolResolver::resolveClass(), ModuleManager::resolveImports(), resolveLink(), ModuleManager::resolvePartitions(), ModuleManager::resolvePartitionsRecursively(), resolveRef(), SymbolResolver::resolveSymbol(), resolveTemplateInstanceInType(), resolveTypeDef(), substituteTemplateArgumentsInString(), SymbolResolver::Private::substTypedef(), transferFunctionDocumentation(), transferFunctionReferences(), transferRelatedFunctionDocumentation(), transferStaticInstanceInitializers(), warnUndocumentedNamespaces(), Markdown::Private::writeBlockQuote(), DirDefImpl::writeBriefDescription(), Markdown::Private::writeCodeBlock(), DirDefImpl::writeDetailedDescription(), ClassDefImpl::writeDocumentation(), DirDefImpl::writeDocumentation(), DirRelation::writeDocumentation(), ModuleDefImpl::writeDocumentation(), ModuleDefImpl::writeExports(), Markdown::Private::writeFencedCodeBlock(), DirDefImpl::writeFileList(), ModuleDefImpl::writeFiles(), Markdown::Private::writeMarkdownImage(), Markdown::Private::writeOneLineHeaderOrRuler(), DirDefImpl::writeSubDirList(), and Markdown::Private::writeTableBlock().

◆ AUTO_TRACE_ADD

#define AUTO_TRACE_ADD ( ...)
Value:
(void)0

Definition at line 47 of file docnode.cpp.

Referenced by MemberDefImpl::_computeLinkableInProject(), SymbolResolver::Private::accessibleViaUsingDefinition(), SymbolResolver::Private::accessibleViaUsingNamespace(), addClassToContext(), addConceptToContext(), addEnumValuesToEnums(), ModuleManager::addHeader(), ModuleManager::addImport(), addLocalObjCMethod(), addMemberFunction(), DirDefImpl::addUsesDependency(), addVariable(), addVariableToClass(), addVariableToFile(), buildDefineList(), buildDirectories(), buildFunctionList(), buildGroupListFiltered(), buildNamespaceList(), buildTypedefList(), ModuleManager::collectExportedSymbols(), combineDeclarationAndDefinition(), computeCommonDirPrefix(), DirDefImpl::computeDependencies(), computeDirDependencies(), computeTemplateClassRelations(), DirDefImpl::createNewDir(), ClassDefImpl::deepCopy(), DocParser::defaultHandleToken(), distributeConceptGroups(), CodeFragmentManager::Private::FragmentInfo::findBlockMarkers(), findClassRelation(), findEnumDocumentation(), findEnums(), findFriends(), findGlobalMember(), findMember(), findTemplateInstanceRelation(), findUsedClassesForClass(), findUsingDeclarations(), findUsingDeclImports(), findUsingDirectives(), SymbolResolver::Private::followPath(), getCanonicalTypeForIdentifier(), SymbolResolver::Private::getResolvedSymbol(), SymbolResolver::Private::getResolvedSymbolRec(), SymbolResolver::Private::getResolvedType(), SymbolResolver::Private::getResolvedTypeRec(), DocParser::handleImg(), DocParser::handleLinkedWord(), handleParametersCommentBlocks(), SymbolResolver::Private::isAccessibleFrom(), SymbolResolver::Private::isAccessibleFromWithExpScope(), isLinkRef(), makeTemplateInstanceRelation(), mergeArguments(), mergeCategories(), ClassDefImpl::mergeCategory(), SymbolResolver::Private::newResolveTypedef(), organizeSubGroupsFiltered(), DocIncOperator::parse(), DocPara::parse(), CodeFragmentManager::parseCodeFragment(), parseCompounds(), parseInput(), Markdown::Private::processSpecialCommand(), readIncludeFile(), SymbolResolver::resolveClass(), ModuleManager::resolveImports(), ModuleManager::resolvePartitionsRecursively(), resolveRef(), resolveTemplateInstanceInType(), resolveTypeDef(), substituteTemplateArgumentsInString(), transferFunctionReferences(), transferRelatedFunctionDocumentation(), transferStaticInstanceInitializers(), Markdown::Private::writeBlockQuote(), DirDefImpl::writeFileList(), and DirDefImpl::writeSubDirList().

◆ AUTO_TRACE_EXIT

#define AUTO_TRACE_EXIT ( ...)
Value:
(void)0

Definition at line 48 of file docnode.cpp.

Referenced by SymbolResolver::Private::accessibleViaUsingDefinition(), SymbolResolver::Private::accessibleViaUsingNamespace(), ClassDefImpl::ClassDefImpl(), computeIndentExcludingListMarkers(), ClassDefImpl::containsOverload(), DocParser::defaultHandleTitleAndSize(), DocRef::DocRef(), encodeDirName(), extractCanonicalType(), Markdown::extractPageTitle(), Markdown::Private::extractTitleId(), DocParser::findDocsForMemberOrCompound(), Markdown::Private::findEmphasisChar(), Markdown::Private::findEndOfLine(), findFunctionPtr(), findTableColumns(), SymbolResolver::Private::followPath(), getCanonicalTypeForIdentifier(), SymbolResolver::Private::getResolvedSymbol(), SymbolResolver::Private::getResolvedSymbolRec(), SymbolResolver::Private::getResolvedType(), SymbolResolver::Private::getResolvedTypeRec(), DocPara::handleCommand(), DocPara::handleHtmlEndTag(), DocPara::handleHtmlStartTag(), DocPara::handleParamSection(), DocPara::handleStartCode(), DocParser::handleStyleArgument(), hasLineBreak(), DocParser::internalValidatingParseDoc(), SymbolResolver::isAccessibleFrom(), SymbolResolver::Private::isAccessibleFrom(), SymbolResolver::isAccessibleFromWithExpScope(), SymbolResolver::Private::isAccessibleFromWithExpScope(), Markdown::Private::isAtxHeader(), Markdown::Private::isBlockCommand(), isBlockQuote(), isCodeBlock(), isEmptyLine(), isEndOfList(), isExplicitPage(), isFencedCodeBlock(), Markdown::Private::isHeaderline(), isHRuler(), isLinkRef(), isListMarker(), Markdown::Private::isSpecialCommand(), isTableBlock(), isVarWithConstructor(), markdownFileNameToId(), matchArgument2(), mergeScopes(), SymbolResolver::Private::newResolveTypedef(), DocAutoList::parse(), DocAutoListItem::parse(), DocHtmlBlockQuote::parse(), DocHtmlDetails::parse(), DocHtmlList::parse(), DocHtmlListItem::parse(), DocIndexEntry::parse(), DocInternal::parse(), DocPara::parse(), DocParamList::parse(), DocParamSect::parse(), DocParBlock::parse(), DocSection::parse(), DocSimpleSect::parse(), CommentScanner::parseCommentBlock(), DocHtmlList::parseXml(), DocHtmlListItem::parseXml(), DocParamList::parseXml(), DocSimpleSect::parseXml(), Markdown::Private::processCodeSpan(), DocParser::processCopyDoc(), Markdown::Private::processEmphasis(), Markdown::Private::processEmphasis1(), Markdown::Private::processEmphasis2(), Markdown::Private::processEmphasis3(), Markdown::Private::processHtmlTagWrite(), Markdown::Private::processLink(), Markdown::Private::processNmdash(), Markdown::Private::processQuoted(), Markdown::Private::processSpecialCommand(), SymbolResolver::resolveClass(), resolveLink(), SymbolResolver::resolveSymbol(), resolveTypeDef(), substituteTemplateArgumentsInString(), SymbolResolver::Private::substTypedef(), Markdown::Private::writeBlockQuote(), Markdown::Private::writeCodeBlock(), and Markdown::Private::writeTableBlock().

◆ INTERNAL_ASSERT

#define INTERNAL_ASSERT ( x)
Value:
do {} while(0)

Definition at line 51 of file docnode.cpp.

Referenced by DocPara::handleCommand(), DocPara::parse(), and DocSection::parse().

Typedef Documentation

◆ RowSpanList

typedef std::vector<ActiveRowSpan> RowSpanList

List of ActiveRowSpan classes.

Definition at line 2181 of file docnode.cpp.

Function Documentation

◆ checkIfHtmlEndTagEndsAutoList()

static bool checkIfHtmlEndTagEndsAutoList ( DocParser * parser,
const DocNodeVariant * n )
static

Definition at line 5415 of file docnode.cpp.

5416{
5417 // expected hierarchy:
5418 // 1. DocAutoListItem <- n
5419 // 2. DocAutoList <- parent(n)
5420 // 3. DocPara <- parent(parent(n))
5421
5422 // step 1
5423 if (!std::get_if<DocAutoListItem>(n)) // not inside a auto list item
5424 {
5425 return false;
5426 }
5427
5428 // step 2
5429 n = parent(n);
5430 int indent = 0;
5431 const auto docAutoList = std::get_if<DocAutoList>(n);
5432 if (docAutoList) // capture indent
5433 {
5434 indent = docAutoList->indent();
5435 }
5436 else
5437 {
5438 return false;
5439 }
5440
5441 // step 3
5442 n = parent(n);
5443 const auto docPara = std::get_if<DocPara>(n);
5444 if (docPara)
5445 {
5446 QCString tagNameLower = QCString(parser->context.token->name).lower();
5447 auto topStyleChange = [](const DocStyleChangeStack &stack) -> const DocStyleChange &
5448 {
5449 return std::get<DocStyleChange>(*stack.top());
5450 };
5451
5452 if (parser->context.styleStack.empty() || // no style change
5453 (topStyleChange(parser->context.styleStack).tagName()==tagNameLower && // correct style change
5454 topStyleChange(parser->context.styleStack).position()!=parser->context.nodeStack.size()) // wrong position, so normal close
5455 )
5456 {
5457 // insert an artificial 'end of autolist' marker and parse again
5458 QCString indentStr;
5459 indentStr.fill(' ',indent);
5460 parser->tokenizer.unputString("\\ilinebr "+indentStr+".\\ilinebr"+indentStr+"</"+parser->context.token->name+">");
5461 return true;
5462 }
5463 }
5464 return false;
5465}
DocParser::tokenizer
DocTokenizer tokenizer
Definition docparser_p.h:141
DocParser::context
DocParserContext context
Definition docparser_p.h:140
DocStyleChange
Node representing a style change.
Definition docnode.h:264
DocTokenizer::unputString
void unputString(const QCString &tag)
Definition doctokenizer.l:1771
QCString
This is an alternative implementation of QCString.
Definition qcstring.h:101
QCString::fill
void fill(char c, int len=-1)
Fills a string with a predefined character.
Definition qcstring.h:180
QCString::lower
QCString lower() const
Definition qcstring.h:234
parent
constexpr DocNodeVariant * parent(DocNodeVariant *n)
returns the parent node of a given node n or nullptr if the node has no parent.
Definition docnode.h:1324
DocStyleChangeStack
IterableStack< const DocNodeVariant * > DocStyleChangeStack
Definition docparser_p.h:55
DocParserContext::styleStack
DocStyleChangeStack styleStack
Definition docparser_p.h:67
DocParserContext::nodeStack
DocNodeStack nodeStack
Definition docparser_p.h:66
DocParserContext::token
TokenInfo * token
Definition docparser_p.h:92
TokenInfo::name
QCString name
Definition doctokenizer.h:136

References DocParser::context, QCString::fill(), QCString::lower(), TokenInfo::name, DocParserContext::nodeStack, parent(), DocParserContext::styleStack, DocParserContext::token, DocParser::tokenizer, and DocTokenizer::unputString().

Referenced by DocPara::parse().

◆ findAttribute()

static bool findAttribute ( const HtmlAttribList & tagHtmlAttribs,
const char * attrName,
QCString * result )
static

Definition at line 4713 of file docnode.cpp.

4716{
4717
4718 for (const auto &opt : tagHtmlAttribs)
4719 {
4720 if (opt.name==attrName)
4721 {
4722 *result = opt.value;
4723 return TRUE;
4724 }
4725 }
4726 return FALSE;
4727}
TRUE
#define TRUE
Definition qcstring.h:37
FALSE
#define FALSE
Definition qcstring.h:34

References FALSE, and TRUE.

Referenced by DocPara::handleHtmlStartTag().

◆ flattenParagraphs()

static void flattenParagraphs ( DocNodeVariant * root,
DocNodeList & children )
static

Definition at line 816 of file docnode.cpp.

817{
818 DocNodeList newChildren;
819 for (auto &dn : children)
820 {
821 DocPara *para = std::get_if<DocPara>(&dn);
822 if (para)
823 {
824 //// move the children of the paragraph to the end of the newChildren list
825 newChildren.move_append(para->children());
826 }
827 }
828
829 // replace the children list by the newChildren list
830 children.clear();
831 children.move_append(newChildren);
832 // reparent the children
833 for (auto &cn : children)
834 {
835 setParent(&cn,root);
836 // we also need to set the parent for each child of cn, as cn's address may have changed.
837 auto opt_children = call_method_children(&cn);
838 if (opt_children)
839 {
840 for (auto &ccn : *opt_children)
841 {
842 setParent(&ccn,&cn);
843 }
844 }
845 }
846}
DocCompoundNode::children
DocNodeList & children()
Definition docnode.h:142
DocPara
Node representing a paragraph in the documentation tree.
Definition docnode.h:1074
GrowVector::clear
void clear()
clears the contents
Definition growvector.h:143
setParent
static void setParent(DocNodeVariant *n, DocNodeVariant *newParent)
Definition docnode.cpp:118
call_method_children
DocNodeList * call_method_children(DocNodeVariant *v)
Definition docnode.h:1379
DocNodeList::move_append
void move_append(DocNodeList &l)
moves the element of list l at the end of this list.
Definition docnode.cpp:807

References call_method_children(), DocCompoundNode::children(), GrowVector< T >::clear(), DocNodeList::move_append(), and setParent().

Referenced by DocRef::parse(), and DocTitle::parseFromString().

◆ setParent()

static void setParent ( DocNodeVariant * n,
DocNodeVariant * newParent )
static

Definition at line 118 of file docnode.cpp.

119{
120 std::visit([&](auto &&x)->decltype(auto) { return x.setParent(newParent); }, *n);
121}

Referenced by flattenParagraphs().

◆ stripKnownExtensions()

static QCString stripKnownExtensions ( const QCString & text)
static

Strips known html and tex extensions from text.

Definition at line 103 of file docnode.cpp.

104{
105 QCString result=text;
106 if (result.endsWith(".tex"))
107 {
108 result=result.left(result.length()-4);
109 }
110 else if (result.right(Doxygen::htmlFileExtension.length())==
111 QCString(Doxygen::htmlFileExtension))
112 {
113 result=result.left(result.length()-Doxygen::htmlFileExtension.length());
114 }
115 return result;
116}
Doxygen::htmlFileExtension
static QCString htmlFileExtension
Definition doxygen.h:122
QCString::length
size_t length() const
Returns the length of the string, not counting the 0-terminator.
Definition qcstring.h:153
QCString::endsWith
bool endsWith(const char *s) const
Definition qcstring.h:509
QCString::right
QCString right(size_t len) const
Definition qcstring.h:219
QCString::left
QCString left(size_t len) const
Definition qcstring.h:214

References QCString::endsWith(), Doxygen::htmlFileExtension, QCString::left(), QCString::length(), and QCString::right().

Referenced by DocLink::DocLink(), DocRef::DocRef(), and DocSecRefItem::parse().

◆ unescapeCRef()

static void unescapeCRef ( QCString & s)
static

Definition at line 81 of file docnode.cpp.

82{
83 QCString result;
84 const char *p = s.data();
85 if (p)
86 {
87 char c = 0;
88 while ((c=*p++))
89 {
90 if (c=='{') c='<'; else if (c=='}') c='>';
91 result+=c;
92 }
93 }
94
95 result=substitute(result,"&lt;","<");
96 result=substitute(result,"&gt;",">");
97 s = result;
98}
QCString::data
const char * data() const
Returns a pointer to the contents of the string in the form of a 0-terminated C string.
Definition qcstring.h:159
substitute
QCString substitute(const QCString &s, const QCString &src, const QCString &dst)
substitute all occurrences of src in s by dst
Definition qcstring.cpp:477

References QCString::data(), and substitute().

Referenced by DocPara::handleHtmlStartTag().

Variable Documentation

◆ g_plantumlEngine

const StringUnorderedSet g_plantumlEngine
static
Initial value:
{
"uml", "bpm", "wire", "dot", "ditaa",
"salt", "math", "latex", "gantt", "mindmap",
"wbs", "yaml", "creole", "json", "flow",
"board", "git", "hcl", "regex", "ebnf",
"files", "chen", "chronology"
}

Definition at line 69 of file docnode.cpp.

69 {
70 "uml", "bpm", "wire", "dot", "ditaa",
71 "salt", "math", "latex", "gantt", "mindmap",
72 "wbs", "yaml", "creole", "json", "flow",
73 "board", "git", "hcl", "regex", "ebnf",
74 "files", "chen", "chronology"
75};

Referenced by DocPara::handleCommand().

◆ g_sectionLevelToName

const char* g_sectionLevelToName[]
static
Initial value:
=
{
"page",
"section",
"subsection",
"subsubsection",
"paragraph",
"subparagraph"
}

Definition at line 56 of file docnode.cpp.

57{
58 "page",
59 "section",
60 "subsection",
61 "subsubsection",
62 "paragraph",
63 "subparagraph"
64};

Referenced by DocSection::parse().