doxygen
Public Member Functions | List of all members
ModuleDefImpl Class Reference
Inheritance diagram for ModuleDefImpl:
Inheritance graph
[legend]
Collaboration diagram for ModuleDefImpl:
Collaboration graph
[legend]

Public Member Functions

 ModuleDefImpl (const QCString &fileName, int startLine, int startColom, const QCString &name, Type type, const QCString &partitionName)
 
DefType definitionType () const override
 
CodeSymbolType codeSymbolType () const override
 
QCString displayName (bool=TRUE) const override
 
QCString getOutputFileBase () const override
 
QCString anchor () const override
 
bool isLinkableInProject () const override
 
bool isLinkable () const override
 
QCString qualifiedName () const override
 
void writeSummaryLinks (OutputList &ol) const override
 
void writePageNavigation (OutputList &ol) const override
 
Type moduleType () const override
 
QCString partitionName () const override
 
void writeDocumentation (OutputList &ol) override
 
bool isPrimaryInterface () const override
 
MemberList * getMemberList (MemberListType lt) const override
 
const MemberLists & getMemberLists () const override
 
const MemberGroupList & getMemberGroups () const override
 
const ClassLinkedRefMap & getClasses () const override
 
const ConceptLinkedRefMap & getConcepts () const override
 
int countVisibleMembers () const override
 
FileDef * getFileDef () const override
 
const ImportInfoMap & getImports () const override
 
const ImportInfoMap & getExports () const override
 
const ModuleMap & partitions () const override
 
void writeTagFile (TextStream &t) const override
 
FileList getUsedFiles () const override
 
void writeExports (OutputList &ol, const QCString &title)
 
void writeClassDeclarations (OutputList &ol, const QCString &title)
 
void writeConcepts (OutputList &ol, const QCString &title)
 
void writeFiles (OutputList &ol, const QCString &title)
 
void startMemberDeclarations (OutputList &ol)
 
void endMemberDeclarations (OutputList &ol)
 
void startMemberDocumentation (OutputList &ol)
 
void endMemberDocumentation (OutputList &ol)
 
void writeDetailedDescription (OutputList &ol, const QCString &title)
 
void writeBriefDescription (OutputList &ol)
 
void writeMemberGroups (OutputList &ol)
 
void writeMemberDeclarations (OutputList &ol, MemberListType lt, const QCString &title)
 
void writeMemberDocumentation (OutputList &ol, MemberListType lt, const QCString &title)
 
void writeAuthorSection (OutputList &ol)
 
void writeDeclarationLink (OutputList &ol, bool &found, const QCString &header, bool localNames) const
 
void addHeader (int line, const QCString &headerName, bool isSystem)
 
void addImport (int line, const QCString &moduleName, const QCString &partitionName, bool isExported)
 
void addClassToModule (const Entry *root, ClassDef *cd)
 
void addConceptToModule (const Entry *root, ConceptDef *cd)
 
void addMemberToModule (const Entry *root, MemberDef *md)
 
void addPartition (ModuleDefImpl *mod)
 
void addContributingModule (ModuleDefImpl *mod)
 
void setPrimaryInterface (const ModuleDef *mod)
 
void setFileDef (FileDef *fd)
 
void addMemberToList (MemberListType lt, MemberDef *md)
 
void addExportedModule (const QCString &moduleName, const ImportInfo &info)
 
void addListReferences ()
 
void addRequirementReferences ()
 
void addMembersToMemberGroup ()
 
void distributeMemberGroupDocumentation ()
 
void findSectionsInDocumentation ()
 
void sortMemberLists ()
 
void mergeSymbolsFrom (ModuleDefImpl *other)
 
bool hasDetailedDescription () const
 
void countMembers ()
 
- Public Member Functions inherited from DefinitionMixin< ModuleDef >
 DefinitionMixin (const QCString &defFileName, int defLine, int defColumn, const QCString &name, const char *b=nullptr, const char *d=nullptr, bool isSymbol=TRUE)
 
 DefinitionMixin (const DefinitionMixin &other)
 
 DefinitionMixin (DefinitionMixin &&)=delete
 
DefinitionMixin & operator= (const DefinitionMixin &other)
 
DefinitionMixin & operator= (DefinitionMixin &&)=delete
 
bool isAlias () const override
 
const QCString & name () const override
 
bool isAnonymous () const override
 
const QCString & localName () const override
 
QCString qualifiedName () const override
 
QCString symbolName () const override
 
QCString getSourceFileBase () const override
 
QCString getSourceAnchor () const override
 
QCString documentation () const override
 
int docLine () const override
 
QCString docFile () const override
 
QCString briefDescription (bool abbreviate=FALSE) const override
 
QCString briefDescriptionAsTooltip () const override
 
int briefLine () const override
 
QCString inbodyDocumentation () const override
 
QCString inbodyFile () const override
 
int inbodyLine () const override
 
QCString briefFile () const override
 
QCString getDefFileName () const override
 
QCString getDefFileExtension () const override
 
int getDefLine () const override
 
int getDefColumn () const override
 
bool hasDocumentation () const override
 
bool hasUserDocumentation () const override
 
bool isVisibleInProject () const override
 
bool isVisible () const override
 
bool isHidden () const override
 
bool isArtificial () const override
 
bool isExported () const override
 
QCString getReference () const override
 
bool isReference () const override
 
QCString externalReference (const QCString &relPath) const override
 
int getStartDefLine () const override
 
int getStartBodyLine () const override
 
int getEndBodyLine () const override
 
const FileDef * getBodyDef () const override
 
SrcLangExt getLanguage () const override
 
const GroupList & partOfGroups () const override
 
bool isLinkableViaGroup () const override
 
const RefItemVector & xrefListItems () const override
 
const RequirementRefs & requirementReferences () const override
 
const Definition * findInnerCompound (const QCString &name) const override
 
Definition * getOuterScope () const override
 
const MemberVector & getReferencesMembers () const override
 
const MemberVector & getReferencedByMembers () const override
 
bool hasSections () const override
 
bool hasSources () const override
 
bool hasBriefDescription () const override
 
QCString id () const override
 
const SectionRefs & getSectionRefs () const override
 
void setName (const QCString &name) override
 
void setId (const QCString &name) override
 
void setDefFile (const QCString &df, int defLine, int defColumn) override
 
void setDocumentation (const QCString &doc, const QCString &docFile, int docLine, bool stripWhiteSpace=TRUE) override
 
void setBriefDescription (const QCString &brief, const QCString &briefFile, int briefLine) override
 
void setInbodyDocumentation (const QCString &doc, const QCString &docFile, int docLine) override
 
void setReference (const QCString &r) override
 
void addSectionsToDefinition (const std::vector< const SectionInfo * > &anchorList) override
 
void setBodySegment (int defLine, int bls, int ble) override
 
void setBodyDef (const FileDef *fd) override
 
void addSourceReferencedBy (MemberDef *md, const QCString &sourceRefName) override
 
void addSourceReferences (MemberDef *md, const QCString &sourceRefName) override
 
void setRefItems (const RefItemVector &sli) override
 
void setRequirementReferences (const RequirementRefs &rqli) override
 
void mergeRefItems (Definition *def) override
 
void mergeReferences (const Definition *other) override
 
void mergeReferencedBy (const Definition *other) override
 
void addInnerCompound (Definition *def) override
 
void setOuterScope (Definition *def) override
 
void setHidden (bool b) override
 
void setArtificial (bool b) override
 
void setExported (bool b) override
 
void setLanguage (SrcLangExt lang) override
 
void writeSourceDef (OutputList &ol) const override
 
void writeInlineCode (OutputList &ol, const QCString &scopeName) const override
 
bool hasSourceRefs () const override
 
bool hasSourceReffedBy () const override
 
void writeSourceRefs (OutputList &ol, const QCString &scopeName) const override
 
void writeSourceReffedBy (OutputList &ol, const QCString &scopeName) const override
 
bool hasRequirementRefs () const override
 
void writeRequirementRefs (OutputList &ol) const override
 
void makePartOfGroup (GroupDef *gd) override
 
void writeNavigationPath (OutputList &ol) const override
 
QCString navigationPathAsString () const override
 
void writeQuickMemberLinks (OutputList &ol, const MemberDef *md) const override
 
void writeSummaryLinks (OutputList &ol) const override
 
void writePageNavigation (OutputList &ol) const override
 
QCString pathFragment () const override
 
void writeDocAnchorsToTagFile (TextStream &fs) const override
 
void setLocalName (const QCString &name) override
 
void writeToc (OutputList &ol, const LocalToc &lt) const override
 
void computeTooltip () override
 
void _setSymbolName (const QCString &name) override
 
QCString _symbolName () const override
 

Additional Inherited Members

- Public Types inherited from ModuleDef
enum  Type { Interface, Implementation }
 
- Public Types inherited from Definition
enum  DefType {
  TypeClass = 0, TypeFile = 1, TypeNamespace = 2, TypeModule = 3,
  TypeMember = 4, TypeGroup = 5, TypePackage = 6, TypePage = 7,
  TypeDir = 8, TypeConcept = 9
}
 

Member Function Documentation

◆ anchor()

QCString ModuleDefImpl::anchor ( ) const
inlineoverridevirtual

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

Implements Definition.

◆ codeSymbolType()

CodeSymbolType ModuleDefImpl::codeSymbolType ( ) const
inlineoverridevirtual

Used for syntax highlighting symbol class

Implements Definition.

◆ definitionType()

DefType ModuleDefImpl::definitionType ( ) const
inlineoverridevirtual

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

Implements Definition.

◆ displayName()

QCString ModuleDefImpl::displayName ( bool  includeScope = TRUE) const
inlineoverridevirtual

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

Implements Definition.

◆ getOutputFileBase()

QCString ModuleDefImpl::getOutputFileBase ( ) const
overridevirtual

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

Implements Definition.

◆ isLinkable()

bool ModuleDefImpl::isLinkable ( ) const
inlineoverridevirtual

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.

◆ isLinkableInProject()

bool ModuleDefImpl::isLinkableInProject ( ) const
inlineoverridevirtual

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

Implements Definition.

◆ qualifiedName()

QCString ModuleDefImpl::qualifiedName ( ) const
overridevirtual

Returns the fully qualified name of this definition

Implements Definition.

The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.13