#include <groupdef.h>
Inheritance diagram for GroupDef:
Definition at line 43 of file groupdef.h.
| GroupDef::GroupDef | ( | const char * | fileName, | |
| int | line, | |||
| const char * | name, | |||
| const char * | title, | |||
| const char * | refFileName = 0 | |||
| ) |
Definition at line 39 of file groupdef.cpp.
References MemberList::allMembersList, QCString, SIntDict< T >::setAutoDelete(), setGroupTitle(), stripExtension(), and visited.
| GroupDef::~GroupDef | ( | ) |
Definition at line 86 of file groupdef.cpp.
| DefType GroupDef::definitionType | ( | ) | const [inline, virtual] |
Use this for dynamic inspection of the type of the derived class
Implements DefinitionIntf.
Definition at line 48 of file groupdef.h.
References DefinitionIntf::TypeGroup.
| QCString GroupDef::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 1121 of file groupdef.cpp.
References Definition::convertNameToFile(), and Definition::isReference().
Referenced by addGroupListToTitle(), addListReferences(), DotGroupCollaboration::buildGraph(), DotGroupCollaboration::DotGroupCollaboration(), LatexGenerator::endIndexSection(), PageDef::getOutputFileBase(), MemberDef::getOutputFileBase(), writeDocumentation(), writeGroupIndexItem(), and writeGroupTreeNode().
| const char* GroupDef::groupTitle | ( | ) | const [inline] |
Definition at line 50 of file groupdef.h.
Referenced by addGroupListToTitle(), DotGroupCollaboration::buildGraph(), DotGroupCollaboration::DotGroupCollaboration(), PerlModGenerator::generatePerlModForGroup(), validatingParseDoc(), writeDocumentation(), and writeGroupTreeNode().
| void GroupDef::setGroupTitle | ( | const char * | newtitle | ) |
Definition at line 100 of file groupdef.cpp.
References Definition::name().
Referenced by GroupDef().
| bool GroupDef::hasGroupTitle | ( | ) | [inline] |
Definition at line 52 of file groupdef.h.
| void GroupDef::addFile | ( | const FileDef * | def | ) |
| bool GroupDef::addClass | ( | const ClassDef * | def | ) |
Definition at line 164 of file groupdef.cpp.
References SDict< T >::append(), Config_getBool, SDict< T >::find(), SDict< T >::inSort(), Definition::isHidden(), and ClassDef::name.
Referenced by ClassDef::setGroupDefForAllMembers().
| bool GroupDef::addNamespace | ( | const NamespaceDef * | def | ) |
Definition at line 178 of file groupdef.cpp.
References SDict< T >::append(), Config_getBool, SDict< T >::find(), SDict< T >::inSort(), Definition::isHidden(), and Definition::name().
| void GroupDef::addGroup | ( | const GroupDef * | def | ) |
Definition at line 510 of file groupdef.cpp.
| void GroupDef::addParentGroup | ( | const GroupDef * | def | ) |
| void GroupDef::addPage | ( | PageDef * | def | ) |
Definition at line 201 of file groupdef.cpp.
References SDict< T >::append(), Definition::isHidden(), Definition::makePartOfGroup(), and Definition::name().
Referenced by addRelatedPage().
| void GroupDef::addExample | ( | const PageDef * | def | ) |
Definition at line 209 of file groupdef.cpp.
References SDict< T >::append(), Definition::isHidden(), and Definition::name().
| void GroupDef::addDir | ( | const DirDef * | dd | ) |
| bool GroupDef::insertMember | ( | MemberDef * | def, | |
| bool | docOnly = FALSE | |||
| ) |
Definition at line 247 of file groupdef.cpp.
References MemberList::append(), SDict< T >::append(), MemberDef::argumentList(), MemberList::decDefineMembers, MemberList::decEnumMembers, MemberList::decEnumValMembers, MemberList::decEventMembers, MemberList::decFriendMembers, MemberList::decFuncMembers, MemberList::decPriSlotMembers, MemberList::decPropMembers, MemberList::decProSlotMembers, MemberList::decProtoMembers, MemberList::decPubSlotMembers, MemberList::decSignalMembers, MemberList::decTypedefMembers, MemberList::decVarMembers, MemberDef::Define, DefinitionIntf::definitionType(), MemberList::docDefineMembers, MemberList::docEnumMembers, MemberList::docEnumValMembers, MemberList::docEventMembers, MemberList::docFriendMembers, MemberList::docFuncMembers, MemberList::docPriSlotMembers, MemberList::docPropMembers, MemberList::docProSlotMembers, MemberList::docProtoMembers, MemberList::docPubSlotMembers, MemberList::docSignalMembers, MemberList::docTypedefMembers, MemberList::docVarMembers, MemberDef::Enumeration, MemberDef::EnumValue, err(), MemberDef::Event, MemberDef::Friend, MemberDef::Function, MemberDef::getClassDef(), MemberDef::getFileDef(), Definition::getOuterScope(), MemberDef::isFunction(), Definition::isHidden(), matchArguments2(), MemberInfo::memberDef, MemberNameInfo::memberName(), MemberDef::memberType(), Definition::name(), ClassDef::name, MemberDef::name, LockingPtr< T >::pointer(), MemberDef::Property, Protected, MemberDef::protection(), MemberDef::Prototype, Public, MemberDef::setGroupAlias(), MemberDef::Signal, MemberDef::Slot, MemberDef::Typedef, DefinitionIntf::TypeFile, and MemberDef::Variable.
Referenced by addMemberToGroups(), MemberGroup::insertMember(), and ClassDef::setGroupDefForAllMembers().
| void GroupDef::removeMember | ( | MemberDef * | md | ) |
Definition at line 413 of file groupdef.cpp.
References MemberList::allMembersList, MemberList::decDefineMembers, MemberList::decEnumMembers, MemberList::decEnumValMembers, MemberList::decEventMembers, MemberList::decFriendMembers, MemberList::decFuncMembers, MemberList::decPriSlotMembers, MemberList::decPropMembers, MemberList::decProSlotMembers, MemberList::decProtoMembers, MemberList::decPubSlotMembers, MemberList::decSignalMembers, MemberList::decTypedefMembers, MemberList::decVarMembers, MemberDef::Define, MemberList::docDefineMembers, MemberList::docEnumMembers, MemberList::docEnumValMembers, MemberList::docEventMembers, MemberList::docFriendMembers, MemberList::docFuncMembers, MemberList::docPriSlotMembers, MemberList::docPropMembers, MemberList::docProSlotMembers, MemberList::docProtoMembers, MemberList::docPubSlotMembers, MemberList::docSignalMembers, MemberList::docTypedefMembers, MemberList::docVarMembers, MemberDef::Enumeration, MemberDef::EnumValue, err(), MemberDef::Event, SDict< T >::find(), MemberDef::Friend, MemberDef::Function, MemberDef::memberType(), MemberDef::name, MemberDef::Property, Protected, MemberDef::protection(), MemberDef::Prototype, Public, SDict< T >::remove(), MemberDef::Signal, MemberDef::Slot, MemberDef::Typedef, and MemberDef::Variable.
Referenced by addMemberToGroups().
| bool GroupDef::containsGroup | ( | const GroupDef * | def | ) |
Definition at line 505 of file groupdef.cpp.
| void GroupDef::writeDetailedDocumentation | ( | OutputList & | ol | ) |
Definition at line 543 of file groupdef.cpp.
References Definition::briefDescription(), Definition::briefFile(), Definition::briefLine(), Config_getBool, SDict< T >::count(), countMembers(), 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 GroupDef::writeDocumentation | ( | OutputList & | ol | ) |
Definition at line 577 of file groupdef.cpp.
References addGroupListToTitle(), SearchIndex::addWord(), Definition::briefDescription(), Definition::briefFile(), Definition::briefLine(), Config_getBool, Config_getString, convertToXML(), MemberList::decDefineMembers, MemberList::decEnumMembers, MemberList::decEnumValMembers, MemberList::decEventMembers, MemberList::decFriendMembers, MemberList::decFuncMembers, MemberList::decPriSlotMembers, MemberList::decPropMembers, MemberList::decProSlotMembers, MemberList::decProtoMembers, MemberList::decPubSlotMembers, MemberList::decSignalMembers, MemberList::decTypedefMembers, MemberList::decVarMembers, OutputList::disable(), OutputList::disableAllBut(), DirDef::displayName(), Definition::docFile(), OutputList::docify(), Definition::docLine(), Definition::documentation(), OutputList::enableAll(), endFile(), OutputList::endGroupCollaboration(), OutputList::endMemberDescription(), OutputList::endMemberHeader(), OutputList::endMemberItem(), OutputList::endMemberList(), OutputList::endMemberSections(), OutputList::endSection(), OutputList::endTextBlock(), OutputList::endTextLink(), endTitle(), PageDef::getOutputFileBase(), DirDef::getOutputFileBase(), FileDef::getOutputFileBase(), getOutputFileBase(), Definition::getReference(), groupTitle(), Doxygen::htmlFileExtension, OutputList::insertMemberAlign(), Definition::isReference(), DotGroupCollaboration::isTrivial(), SDict< PageDef >::Iterator, SIntDict< MemberGroup >::Iterator, SectionInfo::label, OutputGenerator::Latex, OutputGenerator::Man, msg(), FileDef::name(), Definition::name(), OutputList::newParagraph(), OutputList::parseDoc(), OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), QCString, Definition::qualifiedName(), OutputGenerator::RTF, Doxygen::searchIndex, Doxygen::sectionDict, SearchIndex::setCurrentDoc(), DirDef::shortName(), startFile(), OutputList::startGroupCollaboration(), OutputList::startMemberDescription(), OutputList::startMemberHeader(), OutputList::startMemberItem(), OutputList::startMemberList(), OutputList::startMemberSections(), OutputList::startSection(), OutputList::startTextBlock(), OutputList::startTextLink(), startTitle(), SectionInfo::Subsection, Doxygen::tagFile, theTranslator, SectionInfo::title, PageDef::title(), Translator::trCollaborationDiagram(), Translator::trDefines(), Translator::trDir(), Translator::trDirectories(), Translator::trEnumerations(), Translator::trEnumerationValues(), Translator::trEvents(), Translator::trFile(), Translator::trFriends(), Translator::trFuncProtos(), VhdlDocGen::trFunctionAndProc(), Translator::trFunctions(), Translator::trModules(), Translator::trMore(), Translator::trPrivateSlots(), Translator::trProperties(), Translator::trProtectedSlots(), Translator::trPublicSlots(), Translator::trSignals(), Translator::trSubprograms(), Translator::trTypedefs(), Translator::trVariables(), ClassSDict::writeDeclaration(), NamespaceSDict::writeDeclaration(), MemberGroup::writeDeclarations(), writeDetailedDocumentation(), Definition::writeDocAnchorsToTagFile(), writeMemberDocumentation(), writeMemberPages(), OutputList::writeObjectLink(), and OutputList::writeString().
| void GroupDef::writeMemberDocumentation | ( | OutputList & | ol | ) |
Definition at line 832 of file groupdef.cpp.
References Config_getBool, OutputList::disable(), MemberList::docDefineMembers, MemberList::docEnumMembers, MemberList::docEnumValMembers, MemberList::docEventMembers, MemberList::docFriendMembers, MemberList::docFuncMembers, MemberList::docPriSlotMembers, MemberList::docPropMembers, MemberList::docProSlotMembers, MemberList::docProtoMembers, MemberList::docPubSlotMembers, MemberList::docSignalMembers, MemberList::docTypedefMembers, MemberList::docVarMembers, OutputGenerator::Html, theTranslator, Translator::trDefineDocumentation(), Translator::trEnumerationTypeDocumentation(), Translator::trEnumerationValueDocumentation(), Translator::trEvents(), Translator::trFriends(), Translator::trFunctionDocumentation(), Translator::trFunctionPrototypeDocumentation(), Translator::trPrivateSlots(), Translator::trProperties(), Translator::trProtectedSlots(), Translator::trPublicSlots(), Translator::trSignals(), Translator::trSubprogramDocumentation(), Translator::trTypedefDocumentation(), and Translator::trVariableDocumentation().
Referenced by writeDocumentation().
| void GroupDef::writeMemberPages | ( | OutputList & | ol | ) |
Definition at line 861 of file groupdef.cpp.
References OutputList::disableAllBut(), MemberList::documentationLists, OutputGenerator::Html, MemberList::listType(), Definition::name(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), and MemberList::writeDocumentationPage().
Referenced by writeDocumentation().
| void GroupDef::writeQuickMemberLinks | ( | OutputList & | ol, | |
| MemberDef * | currentMd | |||
| ) | const [virtual] |
Reimplemented from Definition.
Definition at line 887 of file groupdef.cpp.
References MemberDef::anchor, Config_getBool, createSubDirs(), MemberDef::getGroupDef(), MemberDef::getOutputFileBase(), Doxygen::htmlFileExtension, MemberDef::isLinkable(), MemberDef::isLinkableInProject(), Definition::localName(), and OutputList::writeString().
| int GroupDef::countMembers | ( | ) | const |
Definition at line 525 of file groupdef.cpp.
References SDict< T >::count().
Referenced by writeDetailedDocumentation().
| bool GroupDef::isLinkableInProject | ( | ) | const [inline, virtual] |
Returns TRUE iff it is possible to link to this item within this project.
Implements Definition.
Definition at line 70 of file groupdef.h.
References Definition::isReference().
Referenced by MemberDef::isLinkableInProject().
| bool GroupDef::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 74 of file groupdef.h.
Referenced by getDefs().
| bool GroupDef::isASubGroup | ( | ) | const |
Definition at line 519 of file groupdef.cpp.
References Definition::partOfGroups().
Referenced by writeGroupTreeNode().
| void GroupDef::computeAnchors | ( | ) |
Compute the HTML anchor names for all members in the group
Definition at line 537 of file groupdef.cpp.
References setAnchors().
| void GroupDef::addMembersToMemberGroup | ( | ) |
Definition at line 216 of file groupdef.cpp.
References MemberList::declarationLists, SIntDict< MemberGroup >::Iterator, MemberList::listType(), and MemberGroup::setInGroup().
| void GroupDef::distributeMemberGroupDocumentation | ( | ) |
Definition at line 116 of file groupdef.cpp.
References MemberGroup::distributeMemberGroupDocumentation(), and SIntDict< MemberGroup >::Iterator.
| void GroupDef::findSectionsInDocumentation | ( | ) |
Definition at line 126 of file groupdef.cpp.
References MemberList::declarationLists, Definition::docFile(), docFindSections(), Definition::documentation(), MemberList::findSectionsInDocumentation(), MemberGroup::findSectionsInDocumentation(), SIntDict< MemberGroup >::Iterator, and MemberList::listType().
| void GroupDef::addListReferences | ( | ) |
Definition at line 1133 of file groupdef.cpp.
References MemberList::addListReferences(), MemberGroup::addListReferences(), addRefItem(), MemberList::documentationLists, getOutputFileBase(), SIntDict< MemberGroup >::Iterator, MemberList::listType(), Definition::name(), LockingPtr< T >::pointer(), theTranslator, Translator::trGroup(), and Definition::xrefListItems().
| void GroupDef::setGroupScope | ( | Definition * | d | ) | [inline] |
Definition at line 92 of file groupdef.h.
| Definition* GroupDef::getGroupScope | ( | ) | const [inline] |
Definition at line 93 of file groupdef.h.
| MemberList * GroupDef::getMemberList | ( | MemberList::ListType | lt | ) | const |
Definition at line 1199 of file groupdef.cpp.
References MemberList::listType(), and m_memberLists.
Referenced by DotGroupCollaboration::buildGraph(), PerlModGenerator::generatePerlModForGroup(), and writeGroupTreeNode().
| const QList<MemberList>& GroupDef::getMemberLists | ( | ) | const [inline] |
| MemberGroupSDict* GroupDef::getMemberGroupSDict | ( | ) | const [inline] |
Definition at line 99 of file groupdef.h.
Referenced by PerlModGenerator::generatePerlModForGroup().
| FileList* GroupDef::getFiles | ( | ) | const [inline] |
Definition at line 101 of file groupdef.h.
Referenced by DotGroupCollaboration::buildGraph(), and PerlModGenerator::generatePerlModForGroup().
| ClassSDict* GroupDef::getClasses | ( | ) | const [inline] |
Definition at line 102 of file groupdef.h.
Referenced by DotGroupCollaboration::buildGraph(), and PerlModGenerator::generatePerlModForGroup().
| NamespaceSDict* GroupDef::getNamespaces | ( | ) | const [inline] |
Definition at line 103 of file groupdef.h.
Referenced by DotGroupCollaboration::buildGraph(), and PerlModGenerator::generatePerlModForGroup().
| GroupList* GroupDef::getSubGroups | ( | ) | const [inline] |
Definition at line 104 of file groupdef.h.
Referenced by DotGroupCollaboration::buildGraph(), and PerlModGenerator::generatePerlModForGroup().
| PageSDict* GroupDef::getPages | ( | ) | const [inline] |
Definition at line 105 of file groupdef.h.
Referenced by DotGroupCollaboration::buildGraph(), and PerlModGenerator::generatePerlModForGroup().
| DirList* GroupDef::getDirs | ( | ) | const [inline] |
| void GroupDef::addMemberListToGroup | ( | MemberList * | , | |
| bool(MemberDef::*)() | const | |||
| ) | [protected] |
| void writeGroupTreeNode | ( | OutputList & | ol, | |
| GroupDef * | gd, | |||
| int | level | |||
| ) | [friend] |
| bool GroupDef::visited |
1.5.1