Public Member Functions | List of all members
GroupDefImpl Class Reference
Inheritance diagram for GroupDefImpl:
Inheritance graph
Collaboration diagram for GroupDefImpl:
Collaboration graph

Public Member Functions

 GroupDefImpl (const QCString &fileName, int line, const QCString &name, const QCString &title, const QCString &refFileName=QCString())
virtual DefType definitionType () const
virtual CodeSymbolType codeSymbolType () const
virtual QCString getOutputFileBase () const
virtual QCString anchor () const
virtual QCString displayName (bool=TRUE) const
virtual QCString groupTitle () const
virtual void setGroupTitle (const QCString &newtitle)
virtual bool hasGroupTitle () const
virtual void addFile (const FileDef *def)
virtual bool addClass (const ClassDef *def)
virtual bool addConcept (const ConceptDef *def)
virtual bool addNamespace (const NamespaceDef *def)
virtual void addGroup (const GroupDef *def)
virtual void addPage (const PageDef *def)
virtual void addExample (const PageDef *def)
virtual void addDir (DirDef *dd)
virtual bool insertMember (const MemberDef *def, bool docOnly=FALSE)
virtual void removeMember (MemberDef *md)
virtual bool findGroup (const GroupDef *def) const
virtual void writeDocumentation (OutputList &ol)
virtual void writeMemberPages (OutputList &ol)
virtual void writeQuickMemberLinks (OutputList &ol, const MemberDef *currentMd) const
virtual void writeTagFile (TextStream &)
virtual size_t numDocMembers () const
virtual bool isLinkableInProject () const
virtual bool isLinkable () const
virtual bool isASubGroup () const
virtual void computeAnchors ()
virtual void countMembers ()
virtual void addMembersToMemberGroup ()
virtual void distributeMemberGroupDocumentation ()
virtual void findSectionsInDocumentation ()
virtual void addListReferences ()
virtual void sortMemberLists ()
virtual bool subGrouping () const
virtual void setGroupScope (Definition *d)
virtual DefinitiongetGroupScope () const
virtual MemberListgetMemberList (MemberListType lt) const
virtual const MemberListsgetMemberLists () const
virtual const MemberGroupListgetMemberGroups () const
virtual const FileListgetFiles () const
virtual const ClassLinkedRefMapgetClasses () const
virtual const ConceptLinkedRefMapgetConcepts () const
virtual const NamespaceLinkedRefMapgetNamespaces () const
virtual const GroupListgetSubGroups () const
virtual const PageLinkedRefMapgetPages () const
virtual const DirListgetDirs () const
virtual const PageLinkedRefMapgetExamples () const
virtual bool hasDetailedDescription () const
virtual void sortSubGroups ()
- Public Member Functions inherited from DefinitionMixin< GroupDef >
 DefinitionMixin (const QCString &defFileName, int defLine, int defColumn, const QCString &name, const char *b=0, const char *d=0, bool isSymbol=TRUE)
virtual bool isAlias () const
virtual QCString name () const
virtual bool isAnonymous () const
virtual QCString localName () const
virtual QCString qualifiedName () const
virtual QCString symbolName () const
virtual QCString getSourceFileBase () const
virtual QCString getSourceAnchor () const
virtual QCString documentation () const
virtual int docLine () const
virtual QCString docFile () const
virtual QCString briefDescription (bool abbreviate=FALSE) const
virtual QCString briefDescriptionAsTooltip () const
virtual int briefLine () const
virtual QCString inbodyDocumentation () const
virtual QCString inbodyFile () const
virtual int inbodyLine () const
virtual QCString briefFile () const
virtual QCString getDefFileName () const
virtual QCString getDefFileExtension () const
virtual int getDefLine () const
virtual int getDefColumn () const
virtual bool hasDocumentation () const
virtual bool hasUserDocumentation () const
virtual bool isVisibleInProject () const
virtual bool isVisible () const
virtual bool isHidden () const
virtual bool isArtificial () const
virtual QCString getReference () const
virtual bool isReference () const
virtual QCString externalReference (const QCString &relPath) const
virtual int getStartDefLine () const
virtual int getStartBodyLine () const
virtual int getEndBodyLine () const
virtual const FileDefgetBodyDef () const
virtual SrcLangExt getLanguage () const
virtual const GroupListpartOfGroups () const
virtual bool isLinkableViaGroup () const
virtual const RefItemVector & xrefListItems () const
virtual const DefinitionfindInnerCompound (const QCString &name) const
virtual DefinitiongetOuterScope () const
virtual const MemberVectorgetReferencesMembers () const
virtual const MemberVectorgetReferencedByMembers () const
virtual bool hasSections () const
virtual bool hasSources () const
virtual bool hasBriefDescription () const
virtual QCString id () const
virtual const SectionRefsgetSectionRefs () const
virtual void setName (const QCString &name)
virtual void setId (const QCString &name)
virtual void setDefFile (const QCString &df, int defLine, int defColumn)
virtual void setDocumentation (const QCString &doc, const QCString &docFile, int docLine, bool stripWhiteSpace=TRUE)
virtual void setBriefDescription (const QCString &brief, const QCString &briefFile, int briefLine)
virtual void setInbodyDocumentation (const QCString &doc, const QCString &docFile, int docLine)
virtual void setReference (const QCString &r)
virtual void addSectionsToDefinition (const std::vector< const SectionInfo * > &anchorList)
virtual void setBodySegment (int defLine, int bls, int ble)
virtual void setBodyDef (const FileDef *fd)
virtual void addSourceReferencedBy (const MemberDef *md)
virtual void addSourceReferences (const MemberDef *md)
virtual void setRefItems (const RefItemVector &sli)
virtual void mergeRefItems (Definition *def)
virtual void mergeReferences (const Definition *other)
virtual void mergeReferencedBy (const Definition *other)
virtual void addInnerCompound (const Definition *def)
virtual void setOuterScope (Definition *def)
virtual void setHidden (bool b)
virtual void setArtificial (bool b)
virtual void setLanguage (SrcLangExt lang)
virtual void writeSourceDef (OutputList &ol, const QCString &scopeName) const
virtual void writeInlineCode (OutputList &ol, const QCString &scopeName) const
virtual bool hasSourceRefs () const
virtual bool hasSourceReffedBy () const
virtual void writeSourceRefs (OutputList &ol, const QCString &scopeName) const
virtual void writeSourceReffedBy (OutputList &ol, const QCString &scopeName) const
virtual void makePartOfGroup (const GroupDef *gd)
virtual void writeNavigationPath (OutputList &ol) const
virtual QCString navigationPathAsString () const
virtual QCString pathFragment () const
virtual void writeDocAnchorsToTagFile (TextStream &fs) const
virtual void setLocalName (const QCString &name)
virtual void addSectionsToIndex ()
virtual void writeToc (OutputList &ol, const LocalToc &lt) const
virtual void computeTooltip ()
virtual void _setSymbolName (const QCString &name)
virtual QCString _symbolName () const

Additional Inherited Members

- Public Types inherited from Definition
enum  DefType {
  TypeClass = 0, TypeFile = 1, TypeNamespace = 2, TypeMember = 3,
  TypeGroup = 4, TypePackage = 5, TypePage = 6, TypeDir = 7,
  TypeConcept = 8
- Protected Member Functions inherited from DefinitionMixin< GroupDef >
 DefinitionMixin (const DefinitionMixin &def)=default

Member Function Documentation

◆ anchor()

virtual QCString GroupDefImpl::anchor ( ) const

Returns the anchor within a page where this item can be found

Implements GroupDef.

◆ codeSymbolType()

virtual CodeSymbolType GroupDefImpl::codeSymbolType ( ) const

Used for syntax highlighting symbol class

Implements Definition.

◆ computeAnchors()

void GroupDefImpl::computeAnchors ( )

Compute the HTML anchor names for all members in the group

Implements GroupDef.

◆ definitionType()

virtual DefType GroupDefImpl::definitionType ( ) const

Use this for dynamic inspection of the type of the derived class

Implements GroupDef.

◆ displayName()

virtual QCString GroupDefImpl::displayName ( bool  includeScope = TRUE) const

Returns the name of the definition as it appears in the output

Implements GroupDef.

◆ getOutputFileBase()

QCString GroupDefImpl::getOutputFileBase ( ) const

Returns the base file name (without extension) of this definition. as it is referenced to/written to disk.

Implements GroupDef.

◆ isLinkable()

bool GroupDefImpl::isLinkable ( ) const

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 GroupDef.

◆ isLinkableInProject()

bool GroupDefImpl::isLinkableInProject ( ) const

Returns TRUE iff it is possible to link to this item within this project.

Implements GroupDef.

The documentation for this class was generated from the following file: