#include <pagedef.h>
Inheritance diagram for PageDef:
Public Member Functions | |
| PageDef (const char *f, int l, const char *n, const char *d, const char *t) | |
| ~PageDef () | |
| DefType | definitionType () const |
| bool | isLinkableInProject () const |
| bool | isLinkable () const |
| void | addSubPage (PageDef *def) |
| void | writeDocumentation (OutputList &ol) |
| QCString | getOutputFileBase () const |
| void | findSectionsInDocumentation () |
| QCString | title () const |
| GroupDef * | getGroupDef () const |
| PageSDict * | getSubPages () const |
| void | setFileName (const char *name) |
| void | addInnerCompound (Definition *d) |
| bool | visibleInIndex () const |
| bool | documentedPage () const |
| bool | hasSubPages () const |
| void | setPageScope (Definition *d) |
| Definition * | getPageScope () const |
Definition at line 24 of file pagedef.h.
| PageDef::PageDef | ( | const char * | f, | |
| int | l, | |||
| const char * | n, | |||
| const char * | d, | |||
| const char * | t | |||
| ) |
| PageDef::~PageDef | ( | ) |
Definition at line 20 of file pagedef.cpp.
| DefType PageDef::definitionType | ( | ) | const [inline, virtual] |
Use this for dynamic inspection of the type of the derived class
Implements DefinitionIntf.
Definition at line 29 of file pagedef.h.
References DefinitionIntf::TypePage.
Referenced by visibleInIndex().
| bool PageDef::isLinkableInProject | ( | ) | const [inline, virtual] |
Returns TRUE iff it is possible to link to this item within this project.
Implements Definition.
Definition at line 30 of file pagedef.h.
References Definition::hasDocumentation(), and Definition::isReference().
Referenced by isLinkable().
| bool PageDef::isLinkable | ( | ) | const [inline, virtual] |
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 34 of file pagedef.h.
References isLinkableInProject(), and Definition::isReference().
| void PageDef::addSubPage | ( | PageDef * | def | ) |
| void PageDef::writeDocumentation | ( | OutputList & | ol | ) |
Definition at line 54 of file pagedef.cpp.
References Config_getBool, Config_getString, convertToXML(), OutputList::disable(), OutputList::disableAllBut(), Definition::docFile(), Definition::docLine(), Definition::documentation(), endFile(), OutputList::endQuickIndices(), OutputList::endSection(), OutputList::endTextBlock(), OutputList::endTitleHead(), found, Definition::getOuterScope(), getOutputFileBase(), Doxygen::globalScope, HLI_None, SectionInfo::label, OutputGenerator::Latex, RefList::listName(), OutputGenerator::Man, Definition::name(), OutputList::parseDoc(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), QCString, Doxygen::sectionDict, OutputList::startContents(), startFile(), OutputList::startSection(), OutputList::startTextBlock(), OutputList::startTitleHead(), stringToSearchIndex(), Doxygen::tagFile, theTranslator, SectionInfo::title, title(), Translator::trPage(), SectionInfo::type, Definition::writeDocAnchorsToTagFile(), Definition::writeNavigationPath(), and Doxygen::xrefLists.
| QCString PageDef::getOutputFileBase | ( | ) | const [virtual] |
Returns the base file name (without extension) of this definition. as it is referenced to/written to disk.
Implements Definition.
Definition at line 36 of file pagedef.cpp.
References getGroupDef(), and GroupDef::getOutputFileBase().
Referenced by DotGroupCollaboration::buildGraph(), LatexGenerator::endIndexSection(), writeDocumentation(), GroupDef::writeDocumentation(), writeExampleIndex(), writeGroupTreeNode(), writeIndex(), and writePageIndex().
| void PageDef::findSectionsInDocumentation | ( | ) |
Definition at line 25 of file pagedef.cpp.
References Definition::docFile(), docFindSections(), and Definition::documentation().
| QCString PageDef::title | ( | ) | const [inline] |
Definition at line 44 of file pagedef.h.
Referenced by LatexGenerator::endIndexSection(), PerlModGenerator::generatePerlModForGroup(), validatingParseDoc(), writeDocumentation(), GroupDef::writeDocumentation(), writeExampleIndex(), writeGroupTreeNode(), writeIndex(), and writePageIndex().
| GroupDef * PageDef::getGroupDef | ( | ) | const |
Definition at line 30 of file pagedef.cpp.
References Definition::partOfGroups().
Referenced by documentedPage(), LatexGenerator::endIndexSection(), getOutputFileBase(), resolveLink(), visibleInIndex(), and writeIndex().
| void PageDef::setFileName | ( | const char * | name | ) | [inline] |
| void PageDef::addInnerCompound | ( | Definition * | d | ) | [virtual] |
Reimplemented from Definition.
Definition at line 44 of file pagedef.cpp.
References SDict< T >::append(), DefinitionIntf::definitionType(), Definition::setOuterScope(), and DefinitionIntf::TypePage.
| bool PageDef::visibleInIndex | ( | ) | const |
Definition at line 134 of file pagedef.cpp.
References Config_getBool, definitionType(), getGroupDef(), Definition::getOuterScope(), Definition::isReference(), and DefinitionIntf::TypePage.
Referenced by countRelatedPages(), and writePageIndex().
| bool PageDef::documentedPage | ( | ) | const |
Definition at line 146 of file pagedef.cpp.
References getGroupDef(), and Definition::isReference().
Referenced by countRelatedPages().
| bool PageDef::hasSubPages | ( | ) | const |
Definition at line 154 of file pagedef.cpp.
References SDict< T >::count().
Referenced by writePageIndex().
| void PageDef::setPageScope | ( | Definition * | d | ) | [inline] |
| Definition* PageDef::getPageScope | ( | ) | const [inline] |
1.5.1