#include <dirdef.h>
Inheritance diagram for DirDef:
Public Member Functions | |
| DirDef (const char *path) | |
| virtual | ~DirDef () |
| virtual DefType | definitionType () const |
| virtual QCString | getOutputFileBase () const |
| virtual bool | isLinkableInProject () const |
| virtual bool | isLinkable () const |
| QCString | displayName () const |
| QCString | shortName () const |
| void | addSubDir (DirDef *subdir) |
| FileList * | getFiles () const |
| void | addFile (FileDef *fd) |
| const DirList & | subDirs () const |
| bool | isCluster () const |
| int | level () const |
| DirDef * | parent () const |
| int | dirCount () const |
| const QDict< UsedDir > * | usedDirs () const |
| bool | isParentOf (DirDef *dir) const |
| bool | depGraphIsTrivial () const |
| void | writeDetailedDocumentation (OutputList &ol) |
| void | writeDocumentation (OutputList &ol) |
| void | writeDepGraph (QTextStream &t) |
Static Public Member Functions | |
| static DirDef * | mergeDirectoryInTree (const QCString &path) |
Public Attributes | |
| bool | visited |
Friends | |
| void | computeDirDependencies () |
Definition at line 45 of file dirdef.h.
| DirDef::DirDef | ( | const char * | path | ) |
Definition at line 17 of file dirdef.cpp.
References Definition::setLocalName(), and stripFromPath().
| DirDef::~DirDef | ( | ) | [virtual] |
Definition at line 42 of file dirdef.cpp.
| virtual DefType DirDef::definitionType | ( | ) | const [inline, virtual] |
Use this for dynamic inspection of the type of the derived class
Implements DefinitionIntf.
Definition at line 52 of file dirdef.h.
References DefinitionIntf::TypeDir.
| QCString DirDef::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 104 of file dirdef.cpp.
References Definition::name().
Referenced by DotGroupCollaboration::buildGraph(), LatexGenerator::endIndexSection(), writeDirDependencyGraph(), writeDirTreeNode(), GroupDef::writeDocumentation(), writeDocumentation(), writeDotDirDepGraph(), and DotDirDeps::writeGraph().
| bool DirDef::isLinkableInProject | ( | ) | const [virtual] |
Returns TRUE iff it is possible to link to this item within this project.
Implements Definition.
Definition at line 48 of file dirdef.cpp.
References Config_getBool, and Definition::isReference().
Referenced by countDirs(), LatexGenerator::endIndexSection(), isLinkable(), and LatexGenerator::startIndexSection().
| bool DirDef::isLinkable | ( | ) | const [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 53 of file dirdef.cpp.
References isLinkableInProject(), and Definition::isReference().
Referenced by resolveLink().
| QCString DirDef::displayName | ( | ) | const [inline] |
Definition at line 56 of file dirdef.h.
Referenced by writeDirDependencyGraph(), GroupDef::writeDocumentation(), DirRelation::writeDocumentation(), writeDocumentation(), and DotDirDeps::writeGraph().
| QCString DirDef::shortName | ( | ) | const [inline] |
Definition at line 57 of file dirdef.h.
Referenced by computeDirDependencies(), writeDirTreeNode(), GroupDef::writeDocumentation(), DirRelation::writeDocumentation(), writeDocumentation(), and writeDotDirDepGraph().
| void DirDef::addSubDir | ( | DirDef * | subdir | ) |
Definition at line 58 of file dirdef.cpp.
References m_parent, and Definition::setOuterScope().
Referenced by buildDirectories().
| FileList* DirDef::getFiles | ( | ) | const [inline] |
| void DirDef::addFile | ( | FileDef * | fd | ) |
Definition at line 65 of file dirdef.cpp.
References FileDef::setDirDef().
Referenced by buildDirectories().
| const DirList& DirDef::subDirs | ( | ) | const [inline] |
Definition at line 61 of file dirdef.h.
Referenced by writeDirTreeNode(), and writeDotDirDepGraph().
| bool DirDef::isCluster | ( | ) | const [inline] |
| DirDef* DirDef::parent | ( | ) | const [inline] |
| int DirDef::dirCount | ( | ) | const [inline] |
| const QDict<UsedDir>* DirDef::usedDirs | ( | ) | const [inline] |
Definition at line 66 of file dirdef.h.
Referenced by computeDirDependencies(), and writeDotDirDepGraph().
| bool DirDef::isParentOf | ( | DirDef * | dir | ) | const |
Definition at line 459 of file dirdef.cpp.
References parent().
Referenced by writeDotDirDepGraph().
| bool DirDef::depGraphIsTrivial | ( | ) | const |
| void DirDef::writeDetailedDocumentation | ( | OutputList & | ol | ) |
Definition at line 110 of file dirdef.cpp.
References Definition::briefDescription(), Definition::briefFile(), Definition::briefLine(), Config_getBool, OutputList::disable(), Definition::docFile(), Definition::docLine(), Definition::documentation(), OutputList::endGroupHeader(), OutputGenerator::Latex, OutputList::newParagraph(), OutputList::parseDoc(), OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), OutputGenerator::RTF, OutputList::startGroupHeader(), theTranslator, Translator::trDetailedDescription(), OutputList::writeAnchor(), and OutputList::writeRuler().
Referenced by writeDocumentation().
| void DirDef::writeDocumentation | ( | OutputList & | ol | ) |
Definition at line 139 of file dirdef.cpp.
References Definition::briefDescription(), Definition::briefFile(), Definition::briefLine(), Config_getBool, Config_getString, convertToXML(), OutputList::disable(), OutputList::disableAllBut(), displayName(), OutputList::docify(), OutputList::enableAll(), OutputList::endBold(), OutputList::endDirDepGraph(), endFile(), OutputList::endMemberDescription(), OutputList::endMemberHeader(), OutputList::endMemberItem(), OutputList::endMemberList(), OutputList::endMemberSections(), OutputList::endQuickIndices(), OutputList::endTextLink(), endTitle(), FileDef::generateSourceFile(), FileDef::getOutputFileBase(), getOutputFileBase(), Definition::getReference(), HLI_None, OutputGenerator::Html, Doxygen::htmlFileExtension, FileDef::includeName(), OutputList::insertMemberAlign(), FileDef::isLinkable(), DotDirDeps::isTrivial(), OutputGenerator::Latex, OutputGenerator::Man, msg(), FileDef::name(), Definition::name(), OutputList::newParagraph(), OutputList::parseDoc(), OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), QCString, OutputGenerator::RTF, shortName(), OutputList::startBold(), OutputList::startContents(), OutputList::startDirDepGraph(), startFile(), OutputList::startMemberDescription(), OutputList::startMemberHeader(), OutputList::startMemberItem(), OutputList::startMemberList(), OutputList::startMemberSections(), OutputList::startTextLink(), startTitle(), Doxygen::tagFile, theTranslator, Translator::trCode(), Translator::trDir(), Translator::trDirReference(), Translator::trFile(), Translator::trMore(), writeDetailedDocumentation(), Definition::writeDocAnchorsToTagFile(), Definition::writeNavigationPath(), OutputList::writeObjectLink(), and OutputList::writeString().
Referenced by generateDirDocs().
| void DirDef::writeDepGraph | ( | QTextStream & | t | ) |
Definition at line 559 of file dirdef.cpp.
References writeDotDirDepGraph().
Referenced by writeDirDependencyGraph(), and DotDirDeps::writeGraph().
| DirDef * DirDef::mergeDirectoryInTree | ( | const QCString & | path | ) | [static] |
strip part of path if it matches one of the paths in the Config_getList("STRIP_FROM_PATH") list
Definition at line 542 of file dirdef.cpp.
References Config_getList, and QCString.
Referenced by buildDirectories().
| void computeDirDependencies | ( | ) | [friend] |
Definition at line 697 of file dirdef.cpp.
| bool DirDef::visited |
1.5.1