Doxygen
|
Public Member Functions | |
PageDefImpl (const QCString &f, int l, const QCString &n, const QCString &d, const QCString &t) | |
~PageDefImpl () override | |
void | setFileName (const QCString &name) override |
void | setLocalToc (const LocalToc &tl) override |
void | setShowLineNo (bool) override |
DefType | definitionType () const override |
CodeSymbolType | codeSymbolType () const override |
bool | isLinkableInProject () const override |
bool | isLinkable () const override |
QCString | getOutputFileBase () const override |
QCString | anchor () const override |
void | findSectionsInDocumentation () override |
QCString | title () const override |
const GroupDef * | getGroupDef () const override |
const PageLinkedRefMap & | getSubPages () const override |
void | addInnerCompound (Definition *d) override |
bool | visibleInIndex () const override |
bool | documentedPage () const override |
bool | hasSubPages () const override |
bool | hasParentPage () const override |
bool | hasTitle () const override |
LocalToc | localToc () const override |
void | setPageScope (Definition *d) override |
Definition * | getPageScope () const override |
QCString | displayName (bool=TRUE) const override |
bool | showLineNo () const override |
void | setTitle (const QCString &title) override |
void | writeDocumentation (OutputList &ol) override |
void | writeTagFile (TextStream &) override |
void | setNestingLevel (int l) override |
void | writePageDocumentation (OutputList &ol) const override |
void | addSectionsToIndex () override |
Public Member Functions inherited from DefinitionMixin< PageDef > | |
DefinitionMixin (const QCString &defFileName, int defLine, int defColumn, const QCString &name, const char *b=nullptr, const char *d=nullptr, bool isSymbol=TRUE) | |
DefinitionMixin (const DefinitionMixin &other) | |
DefinitionMixin (DefinitionMixin &&)=delete | |
DefinitionMixin & | operator= (const DefinitionMixin &other) |
DefinitionMixin & | operator= (DefinitionMixin &&)=delete |
~DefinitionMixin () override=default | |
bool | isAlias () const override |
const QCString & | name () const override |
bool | isAnonymous () const override |
const QCString & | localName () const override |
QCString | qualifiedName () const override |
QCString | symbolName () const override |
QCString | getSourceFileBase () const override |
QCString | getSourceAnchor () const override |
QCString | documentation () const override |
int | docLine () const override |
QCString | docFile () const override |
QCString | briefDescription (bool abbreviate=FALSE) const override |
QCString | briefDescriptionAsTooltip () const override |
int | briefLine () const override |
QCString | inbodyDocumentation () const override |
QCString | inbodyFile () const override |
int | inbodyLine () const override |
QCString | briefFile () const override |
QCString | getDefFileName () const override |
QCString | getDefFileExtension () const override |
int | getDefLine () const override |
int | getDefColumn () const override |
bool | hasDocumentation () const override |
bool | hasUserDocumentation () const override |
bool | isVisibleInProject () const override |
bool | isVisible () const override |
bool | isHidden () const override |
bool | isArtificial () const override |
bool | isExported () const override |
QCString | getReference () const override |
bool | isReference () const override |
QCString | externalReference (const QCString &relPath) const override |
int | getStartDefLine () const override |
int | getStartBodyLine () const override |
int | getEndBodyLine () const override |
const FileDef * | getBodyDef () const override |
SrcLangExt | getLanguage () const override |
const GroupList & | partOfGroups () const override |
bool | isLinkableViaGroup () const override |
const RefItemVector & | xrefListItems () const override |
const Definition * | findInnerCompound (const QCString &name) const override |
Definition * | getOuterScope () const override |
const MemberVector & | getReferencesMembers () const override |
const MemberVector & | getReferencedByMembers () const override |
bool | hasSections () const override |
bool | hasSources () const override |
bool | hasBriefDescription () const override |
QCString | id () const override |
const SectionRefs & | getSectionRefs () const override |
void | setName (const QCString &name) override |
void | setId (const QCString &name) override |
void | setDefFile (const QCString &df, int defLine, int defColumn) override |
void | setDocumentation (const QCString &doc, const QCString &docFile, int docLine, bool stripWhiteSpace=TRUE) override |
void | setBriefDescription (const QCString &brief, const QCString &briefFile, int briefLine) override |
void | setInbodyDocumentation (const QCString &doc, const QCString &docFile, int docLine) override |
void | setReference (const QCString &r) override |
void | addSectionsToDefinition (const std::vector< const SectionInfo * > &anchorList) override |
void | setBodySegment (int defLine, int bls, int ble) override |
void | setBodyDef (const FileDef *fd) override |
void | addSourceReferencedBy (MemberDef *md, const QCString &sourceRefName) override |
void | addSourceReferences (MemberDef *md, const QCString &sourceRefName) override |
void | setRefItems (const RefItemVector &sli) override |
void | mergeRefItems (Definition *def) override |
void | mergeReferences (const Definition *other) override |
void | mergeReferencedBy (const Definition *other) override |
void | setOuterScope (Definition *def) override |
void | setHidden (bool b) override |
void | setArtificial (bool b) override |
void | setExported (bool b) override |
void | setLanguage (SrcLangExt lang) override |
void | writeSourceDef (OutputList &ol) const override |
void | writeInlineCode (OutputList &ol, const QCString &scopeName) const override |
bool | hasSourceRefs () const override |
bool | hasSourceReffedBy () const override |
void | writeSourceRefs (OutputList &ol, const QCString &scopeName) const override |
void | writeSourceReffedBy (OutputList &ol, const QCString &scopeName) const override |
void | makePartOfGroup (GroupDef *gd) override |
void | writeNavigationPath (OutputList &ol) const override |
QCString | navigationPathAsString () const override |
void | writeQuickMemberLinks (OutputList &ol, const MemberDef *md) const override |
void | writeSummaryLinks (OutputList &ol) const override |
QCString | pathFragment () const override |
void | writeDocAnchorsToTagFile (TextStream &fs) const override |
void | setLocalName (const QCString &name) override |
void | writeToc (OutputList &ol, const LocalToc <) const override |
void | computeTooltip () override |
void | _setSymbolName (const QCString &name) override |
QCString | _symbolName () const override |
Public Member Functions inherited from PageDef | |
Public Member Functions inherited from DefinitionMutable | |
Public Member Functions inherited from Definition |
Private Attributes | |
QCString | m_fileName |
QCString | m_title |
PageLinkedRefMap | m_subPages |
Definition * | m_pageScope |
int | m_nestingLevel |
LocalToc | m_localToc |
bool | m_showLineNo |
Additional Inherited Members | |
Public Types inherited from Definition | |
enum | DefType { TypeClass = 0 , TypeFile = 1 , TypeNamespace = 2 , TypeModule = 3 , TypeMember = 4 , TypeGroup = 5 , TypePackage = 6 , TypePage = 7 , TypeDir = 8 , TypeConcept = 9 } |
Definition at line 31 of file pagedef.cpp.
PageDefImpl::PageDefImpl | ( | const QCString & | f, |
int | l, | ||
const QCString & | n, | ||
const QCString & | d, | ||
const QCString & | t ) |
Definition at line 86 of file pagedef.cpp.
References convertNameToFile(), DefinitionMixin< PageDef >::DefinitionMixin(), FALSE, m_fileName, m_nestingLevel, m_pageScope, m_showLineNo, m_title, DefinitionMixin< PageDef >::setDocumentation(), and TRUE.
|
override |
Definition at line 97 of file pagedef.cpp.
|
overridevirtual |
Reimplemented from DefinitionMixin< PageDef >.
Definition at line 126 of file pagedef.cpp.
References Definition::definitionType(), m_nestingLevel, m_subPages, Doxygen::mainPage, Definition::name(), PageDef::setNestingLevel(), DefinitionMutable::setOuterScope(), toPageDef(), and Definition::TypePage.
|
overridevirtual |
Implements PageDef.
Definition at line 147 of file pagedef.cpp.
References SectionRefs::begin(), SectionRefs::empty(), SectionRefs::end(), SectionInfo::fileName(), getOutputFileBase(), DefinitionMixin< PageDef >::getReference(), DefinitionMixin< PageDef >::getSectionRefs(), Doxygen::indexList, SectionType::isSection(), SectionInfo::label(), SectionType::level(), SectionInfo::lineNr(), parseCommentAsText(), title(), SectionInfo::title(), and SectionInfo::type().
|
inlineoverridevirtual |
Returns the anchor within a page where this item can be found
Implements Definition.
Definition at line 46 of file pagedef.cpp.
|
inlineoverridevirtual |
Used for syntax highlighting symbol class
Implements Definition.
Definition at line 42 of file pagedef.cpp.
References Default.
|
inlineoverridevirtual |
Use this for dynamic inspection of the type of the derived class
Implements Definition.
Definition at line 41 of file pagedef.cpp.
References Definition::TypePage.
Returns the name of the definition as it appears in the output
Implements Definition.
Definition at line 60 of file pagedef.cpp.
References hasTitle(), m_title, DefinitionMixin< Base >::name(), and TRUE.
|
overridevirtual |
Implements PageDef.
Definition at line 422 of file pagedef.cpp.
References getGroupDef(), and DefinitionMixin< PageDef >::isReference().
|
overridevirtual |
Implements PageDef.
Definition at line 101 of file pagedef.cpp.
References DefinitionMixin< PageDef >::briefDescription(), DefinitionMixin< PageDef >::docFile(), docFindSections(), DefinitionMixin< PageDef >::documentation(), and DefinitionMixin< PageDef >::inbodyDocumentation().
|
overridevirtual |
Implements PageDef.
Definition at line 108 of file pagedef.cpp.
References DefinitionMixin< PageDef >::partOfGroups().
Referenced by documentedPage(), getOutputFileBase(), and visibleInIndex().
|
overridevirtual |
Returns the base file name (without extension) of this definition. as it is referenced to/written to disk.
Implements Definition.
Definition at line 113 of file pagedef.cpp.
References getGroupDef(), Definition::getOutputFileBase(), and m_fileName.
Referenced by addSectionsToIndex(), writeDocumentation(), and writeTagFile().
|
inlineoverridevirtual |
|
inlineoverridevirtual |
|
overridevirtual |
Implements PageDef.
Definition at line 197 of file pagedef.cpp.
References Definition::definitionType(), DefinitionMixin< PageDef >::getOuterScope(), and Definition::TypePage.
|
overridevirtual |
Implements PageDef.
Definition at line 430 of file pagedef.cpp.
References m_subPages.
Referenced by writePageDocumentation().
|
overridevirtual |
Implements PageDef.
Definition at line 455 of file pagedef.cpp.
References m_title.
Referenced by displayName(), and writeDocumentation().
|
inlineoverridevirtual |
Returns TRUE iff it is possible to link to this item. This can be a link to another project imported via a tag file.
Implements Definition.
Definition at line 44 of file pagedef.cpp.
References isLinkableInProject(), and DefinitionMixin< PageDef >::isReference().
|
inlineoverridevirtual |
Returns TRUE iff it is possible to link to this item within this project.
Implements Definition.
Definition at line 43 of file pagedef.cpp.
References DefinitionMixin< PageDef >::isReference().
Referenced by isLinkable().
|
inlineoverridevirtual |
|
overridevirtual |
Implements PageDef.
Definition at line 121 of file pagedef.cpp.
References m_fileName, and DefinitionMixin< PageDef >::name().
|
overridevirtual |
|
overridevirtual |
|
inlineoverridevirtual |
Implements PageDef.
Definition at line 58 of file pagedef.cpp.
References m_pageScope.
|
overridevirtual |
|
overridevirtual |
|
overridevirtual |
|
inlineoverridevirtual |
Implements PageDef.
Definition at line 48 of file pagedef.cpp.
References m_title.
Referenced by addSectionsToIndex(), setTitle(), writeDocumentation(), and writeTagFile().
|
overridevirtual |
Implements PageDef.
Definition at line 413 of file pagedef.cpp.
References Config_getBool, getGroupDef(), and DefinitionMixin< PageDef >::isReference().
|
overridevirtual |
Implements PageDef.
Definition at line 233 of file pagedef.cpp.
References Config_getBool, OutputList::disable(), OutputList::disableAllBut(), DefinitionMixin< PageDef >::docFile(), OutputList::enableAll(), OutputList::endContents(), endFile(), endFileWithNavPath(), OutputList::endHeaderSection(), OutputList::endPageDoc(), OutputList::endQuickIndices(), OutputList::endSection(), OutputList::endTitleHead(), escapeCharsInString(), FALSE, LinkedMap< T, Hash, KeyEqual, Map >::find(), OutputList::generateDoc(), Definition::getOuterScope(), DefinitionMixin< PageDef >::getOuterScope(), getOutputFileBase(), DefinitionMixin< PageDef >::getStartBodyLine(), Doxygen::globalScope, PageDef::hasParentPage(), DefinitionMixin< PageDef >::hasSections(), hasTitle(), SectionManager::instance(), SectionInfo::label(), m_localToc, m_title, Doxygen::mainPage, Man, DefinitionMixin< PageDef >::name(), Pages, OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), OutputList::startContents(), startFile(), OutputList::startHeaderSection(), OutputList::startPageDoc(), OutputList::startTitleHead(), theTranslator, title(), SectionInfo::title(), Definition::toDefinitionMutable, TRUE, SectionInfo::type(), DefinitionMutable::writeNavigationPath(), writePageDocumentation(), OutputList::writeString(), and DefinitionMixin< PageDef >::writeToc().
|
overridevirtual |
Implements PageDef.
Definition at line 351 of file pagedef.cpp.
References DefinitionMixin< PageDef >::briefDescription(), OutputList::disable(), OutputList::disableAll(), OutputList::disableAllBut(), Docbook, DefinitionMixin< PageDef >::docFile(), DefinitionMixin< PageDef >::docLine(), DefinitionMixin< PageDef >::documentation(), OutputList::enable(), OutputList::enableAll(), OutputList::endTextBlock(), FALSE, OutputList::generateDoc(), DefinitionMixin< PageDef >::hasBriefDescription(), hasSubPages(), Html, DefinitionMixin< PageDef >::inbodyDocumentation(), SectionManager::instance(), QCString::isEmpty(), Latex, m_subPages, Man, DefinitionMixin< PageDef >::name(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), RTF, OutputList::startTextBlock(), TRUE, OutputList::writePageLink(), and OutputList::writeString().
Referenced by writeDocumentation().
|
overridevirtual |
Implements PageDef.
Definition at line 203 of file pagedef.cpp.
References addHtmlExtensionIfMissing(), convertToXML(), found, getOutputFileBase(), RefListManager::instance(), m_subPages, DefinitionMixin< PageDef >::name(), title(), TRUE, and DefinitionMixin< PageDef >::writeDocAnchorsToTagFile().
|
private |
Definition at line 70 of file pagedef.cpp.
Referenced by getOutputFileBase(), PageDefImpl(), and setFileName().
|
private |
Definition at line 75 of file pagedef.cpp.
Referenced by localToc(), setLocalToc(), and writeDocumentation().
|
private |
Definition at line 74 of file pagedef.cpp.
Referenced by addInnerCompound(), PageDefImpl(), and setNestingLevel().
|
private |
Definition at line 73 of file pagedef.cpp.
Referenced by getPageScope(), PageDefImpl(), and setPageScope().
|
private |
Definition at line 76 of file pagedef.cpp.
Referenced by PageDefImpl(), setShowLineNo(), and showLineNo().
|
private |
Definition at line 72 of file pagedef.cpp.
Referenced by addInnerCompound(), getSubPages(), hasSubPages(), writePageDocumentation(), and writeTagFile().
|
private |
Definition at line 71 of file pagedef.cpp.
Referenced by displayName(), hasTitle(), PageDefImpl(), setTitle(), title(), and writeDocumentation().