#include <namespacedef.h>
Inheritance diagram for NamespaceDef:
Definition at line 37 of file namespacedef.h.
| NamespaceDef::NamespaceDef | ( | const char * | defFileName, | |
| int | defLine, | |||
| const char * | name, | |||
| const char * | ref = 0, |
|||
| const char * | refFile = 0 | |||
| ) |
Definition at line 32 of file namespacedef.cpp.
References Config_getBool, SIntDict< T >::setAutoDelete(), Definition::setReference(), stripExtension(), and visited.
| NamespaceDef::~NamespaceDef | ( | ) |
Definition at line 58 of file namespacedef.cpp.
| DefType NamespaceDef::definitionType | ( | ) | const [inline, virtual] |
Use this for dynamic inspection of the type of the derived class
Implements DefinitionIntf.
Definition at line 44 of file namespacedef.h.
References DefinitionIntf::TypeNamespace.
| QCString NamespaceDef::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 524 of file namespacedef.cpp.
References Definition::convertNameToFile(), and Definition::isReference().
Referenced by addListReferences(), DotGroupCollaboration::buildGraph(), LatexGenerator::endIndexSection(), generateDEFForNamespace(), MemberDef::getOutputFileBase(), writeAlphabeticalClassList(), NamespaceSDict::writeDeclaration(), writeDocumentation(), FileDef::writeDocumentation(), writeGroupTreeNode(), and writeNamespaceIndex().
| void NamespaceDef::insertUsedFile | ( | const char * | fname | ) |
| void NamespaceDef::writeDetailedDocumentation | ( | OutputList & | ol | ) |
Definition at line 228 of file namespacedef.cpp.
References Definition::briefDescription(), Definition::briefFile(), Definition::briefLine(), Config_getBool, OutputList::disable(), OutputList::disableAllBut(), Definition::docFile(), Definition::docLine(), Definition::documentation(), OutputList::enableAll(), OutputList::endGroupHeader(), OutputList::endTextBlock(), OutputGenerator::Html, OutputGenerator::Man, OutputList::newParagraph(), OutputList::parseDoc(), OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), OutputList::startGroupHeader(), OutputList::startTextBlock(), theTranslator, Translator::trDetailedDescription(), OutputList::writeAnchor(), OutputList::writeRuler(), and OutputList::writeString().
Referenced by writeDocumentation().
| void NamespaceDef::writeDocumentation | ( | OutputList & | ol | ) |
Definition at line 269 of file namespacedef.cpp.
References addGroupListToTitle(), SearchIndex::addWord(), MemberGroup::allMembersInSameSection(), MemberList::allMembersList, Definition::briefDescription(), Definition::briefFile(), Definition::briefLine(), Config_getBool, Config_getString, convertToXML(), MemberList::decDefineMembers, MemberList::decEnumMembers, MemberList::decFuncMembers, MemberList::decProtoMembers, MemberList::decTypedefMembers, MemberList::decVarMembers, OutputList::disable(), OutputList::disableAllBut(), displayName(), OutputList::enable(), OutputList::enableAll(), endFile(), OutputList::endGroupHeader(), OutputList::endMemberSections(), OutputList::endQuickIndices(), OutputList::endTextBlock(), OutputList::endTextLink(), endTitle(), getMemberList(), Definition::getOuterScope(), getOutputFileBase(), Doxygen::globalScope, MemberGroup::header(), HLI_NamespaceVisible, OutputGenerator::Html, Doxygen::htmlFileExtension, SIntDict< MemberGroup >::Iterator, Definition::localName(), OutputGenerator::Man, Definition::name(), OutputList::newParagraph(), OutputList::parseDoc(), OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), QCString, OutputGenerator::RTF, Doxygen::searchIndex, SearchIndex::setCurrentDoc(), OutputList::startContents(), startFile(), OutputList::startGroupHeader(), OutputList::startMemberSections(), OutputList::startTextBlock(), OutputList::startTextLink(), startTitle(), Doxygen::tagFile, theTranslator, Translator::trAuthor(), Translator::trDefines(), Translator::trEnumerations(), Translator::trFuncProtos(), VhdlDocGen::trFunctionAndProc(), Translator::trFunctions(), Translator::trGeneratedAutomatically(), Translator::trModuleReference(), Translator::trMore(), Translator::trNamespaceReference(), Translator::trPackage(), Translator::trSubprograms(), Translator::trTypedefs(), Translator::trVariables(), NamespaceSDict::writeDeclaration(), ClassSDict::writeDeclaration(), MemberGroup::writeDeclarations(), writeDetailedDocumentation(), Definition::writeDocAnchorsToTagFile(), writeMemberDocumentation(), writeMemberPages(), Definition::writeNavigationPath(), OutputList::writeString(), and OutputList::writeSynopsis().
| void NamespaceDef::writeMemberDocumentation | ( | OutputList & | ol | ) |
Definition at line 405 of file namespacedef.cpp.
References Config_getBool, OutputList::disable(), MemberList::docDefineMembers, MemberList::docEnumMembers, MemberList::docFuncMembers, MemberList::docProtoMembers, MemberList::docTypedefMembers, MemberList::docVarMembers, OutputGenerator::Html, theTranslator, Translator::trDefineDocumentation(), Translator::trEnumerationTypeDocumentation(), Translator::trFunctionDocumentation(), Translator::trFunctionPrototypeDocumentation(), Translator::trSubprogramDocumentation(), Translator::trTypedefDocumentation(), and Translator::trVariableDocumentation().
Referenced by writeDocumentation().
| void NamespaceDef::writeMemberPages | ( | OutputList & | ol | ) |
Definition at line 426 of file namespacedef.cpp.
References OutputList::disableAllBut(), MemberList::documentationLists, OutputGenerator::Html, MemberList::listType(), Definition::name(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), and MemberList::writeDocumentationPage().
Referenced by writeDocumentation().
| void NamespaceDef::writeQuickMemberLinks | ( | OutputList & | ol, | |
| MemberDef * | currentMd | |||
| ) | const [virtual] |
Reimplemented from Definition.
Definition at line 443 of file namespacedef.cpp.
References MemberList::allMembersList, MemberDef::anchor, Config_getBool, createSubDirs(), getMemberList(), MemberDef::getNamespaceDef(), MemberDef::getOutputFileBase(), Doxygen::htmlFileExtension, MemberDef::isLinkable(), MemberDef::isLinkableInProject(), Definition::localName(), and OutputList::writeString().
| void NamespaceDef::insertClass | ( | ClassDef * | cd | ) |
Definition at line 122 of file namespacedef.cpp.
References SDict< T >::append(), Config_getBool, SDict< T >::find(), SDict< T >::inSort(), and ClassDef::name.
Referenced by addInnerCompound().
| void NamespaceDef::insertNamespace | ( | NamespaceDef * | nd | ) |
Definition at line 133 of file namespacedef.cpp.
References SDict< T >::append(), Config_getBool, SDict< T >::find(), SDict< T >::inSort(), and Definition::name().
Referenced by addInnerCompound().
| void NamespaceDef::insertMember | ( | MemberDef * | md | ) |
Definition at line 173 of file namespacedef.cpp.
References MemberList::allMembersList, MemberList::append(), MemberList::decDefineMembers, MemberList::decEnumMembers, MemberList::decFuncMembers, MemberList::decProtoMembers, MemberList::decTypedefMembers, MemberList::decVarMembers, MemberDef::Define, MemberList::docDefineMembers, MemberList::docEnumMembers, MemberList::docFuncMembers, MemberList::docProtoMembers, MemberList::docTypedefMembers, MemberList::docVarMembers, MemberDef::Enumeration, MemberDef::EnumValue, err(), MemberDef::Function, MemberDef::getClassDef(), getMemberList(), Definition::isHidden(), MemberDef::memberType(), Definition::name(), ClassDef::name, MemberDef::name, MemberDef::Prototype, MemberDef::Typedef, and MemberDef::Variable.
| void NamespaceDef::computeAnchors | ( | ) |
Definition at line 222 of file namespacedef.cpp.
References MemberList::allMembersList, getMemberList(), and setAnchors().
| int NamespaceDef::countMembers | ( | ) |
Definition at line 486 of file namespacedef.cpp.
References MemberList::allMembersList, SDict< T >::count(), MemberList::countDocMembers(), getMemberList(), and MemberList::numDocMembers().
| void NamespaceDef::addUsingDirective | ( | NamespaceDef * | nd | ) |
Definition at line 493 of file namespacedef.cpp.
References SDict< T >::append(), SDict< T >::find(), and Definition::qualifiedName().
Referenced by combineUsingRelations().
| NamespaceSDict * NamespaceDef::getUsedNamespaces | ( | ) | const |
Definition at line 506 of file namespacedef.cpp.
Referenced by accessibleViaUsingNamespace(), combineUsingRelations(), FileDef::combineUsingRelations(), and isAccessibleFromWithExpScope().
| void NamespaceDef::addUsingDeclaration | ( | Definition * | def | ) |
Definition at line 512 of file namespacedef.cpp.
References SDict< T >::append(), SDict< T >::find(), and Definition::qualifiedName().
Referenced by combineUsingRelations().
| SDict<Definition>* NamespaceDef::getUsedClasses | ( | ) | const [inline] |
Definition at line 63 of file namespacedef.h.
Referenced by combineUsingRelations(), FileDef::combineUsingRelations(), and isAccessibleFromWithExpScope().
| void NamespaceDef::combineUsingRelations | ( | ) |
Definition at line 591 of file namespacedef.cpp.
References addUsingDeclaration(), addUsingDirective(), combineUsingRelations(), getUsedClasses(), getUsedNamespaces(), SDict< NamespaceDef >::Iterator, and visited.
Referenced by combineUsingRelations(), and FileDef::combineUsingRelations().
| QCString NamespaceDef::displayName | ( | ) | const |
Definition at line 581 of file namespacedef.cpp.
References Config_getBool, Definition::name(), QCString, and substitute().
Referenced by addListReferences(), MemberDef::getScopeString(), NamespaceSDict::writeDeclaration(), writeDocumentation(), FileDef::writeDocumentation(), and writeNamespaceIndex().
| bool NamespaceDef::isLinkableInProject | ( | ) | const [virtual] |
Returns TRUE iff it is possible to link to this item within this project.
Implements Definition.
Definition at line 767 of file namespacedef.cpp.
References Config_getBool, Definition::hasDocumentation(), Definition::isArtificial(), Definition::isHidden(), Definition::isReference(), and Definition::name().
Referenced by addNamespaceMemberNameToIndex(), countNamespaces(), LatexGenerator::endIndexSection(), isLinkable(), MemberDef::isLinkableInProject(), LatexGenerator::startIndexSection(), and writeNamespaceIndex().
| bool NamespaceDef::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 780 of file namespacedef.cpp.
References isLinkableInProject(), and Definition::isReference().
Referenced by getDefs(), writeAlphabeticalClassList(), NamespaceSDict::writeDeclaration(), and FileDef::writeDocumentation().
| void NamespaceDef::addMembersToMemberGroup | ( | ) |
Definition at line 145 of file namespacedef.cpp.
References MemberGroup::addToDeclarationSection(), MemberGroup::allMembersInSameSection(), MemberList::declarationLists, SIntDict< MemberGroup >::Iterator, and MemberList::listType().
| void NamespaceDef::distributeMemberGroupDocumentation | ( | ) |
Definition at line 68 of file namespacedef.cpp.
References MemberGroup::distributeMemberGroupDocumentation(), and SIntDict< MemberGroup >::Iterator.
| void NamespaceDef::findSectionsInDocumentation | ( | ) |
Definition at line 78 of file namespacedef.cpp.
References MemberList::declarationLists, Definition::docFile(), docFindSections(), Definition::documentation(), MemberList::findSectionsInDocumentation(), MemberGroup::findSectionsInDocumentation(), SIntDict< MemberGroup >::Iterator, and MemberList::listType().
| Definition * NamespaceDef::findInnerCompound | ( | const char * | name | ) | [virtual] |
Reimplemented from Definition.
Definition at line 536 of file namespacedef.cpp.
References SDict< T >::find().
| void NamespaceDef::addInnerCompound | ( | Definition * | d | ) | [virtual] |
Reimplemented from Definition.
Definition at line 109 of file namespacedef.cpp.
References SDict< T >::append(), DefinitionIntf::definitionType(), insertClass(), insertNamespace(), Definition::localName(), DefinitionIntf::TypeClass, and DefinitionIntf::TypeNamespace.
| void NamespaceDef::addListReferences | ( | ) |
Definition at line 554 of file namespacedef.cpp.
References MemberList::addListReferences(), MemberGroup::addListReferences(), addRefItem(), Config_getBool, displayName(), MemberList::documentationLists, getOutputFileBase(), SIntDict< MemberGroup >::Iterator, MemberList::listType(), LockingPtr< T >::pointer(), theTranslator, Translator::trModule(), Translator::trNamespace(), and Definition::xrefListItems().
| MemberList * NamespaceDef::getMemberList | ( | MemberList::ListType | lt | ) | const |
Definition at line 739 of file namespacedef.cpp.
References MemberList::listType(), and m_memberLists.
Referenced by computeAnchors(), countMembers(), generateDEFForNamespace(), PerlModGenerator::generatePerlModForNamespace(), insertMember(), writeDocumentation(), and writeQuickMemberLinks().
| const QList<MemberList>& NamespaceDef::getMemberLists | ( | ) | const [inline] |
Definition at line 78 of file namespacedef.h.
| MemberGroupSDict* NamespaceDef::getMemberGroupSDict | ( | ) | const [inline] |
Returns the user defined member groups
Definition at line 81 of file namespacedef.h.
Referenced by PerlModGenerator::generatePerlModForNamespace().
| ClassSDict* NamespaceDef::getClassSDict | ( | ) | const [inline] |
Returns the classes contained in this namespace
Definition at line 84 of file namespacedef.h.
Referenced by PerlModGenerator::generatePerlModForNamespace().
| NamespaceSDict* NamespaceDef::getNamespaceSDict | ( | ) | const [inline] |
Returns the namespaces contained in this namespace
Definition at line 87 of file namespacedef.h.
Referenced by PerlModGenerator::generatePerlModForNamespace().
Definition at line 89 of file namespacedef.h.
Referenced by combineUsingRelations(), and NamespaceDef().
1.5.1