ConceptDefMutable Class Reference

#include <src/conceptdef.h>

Inheritance diagram for ConceptDefMutable:

Collaboration diagram for ConceptDefMutable:

Public Member Functions
virtual void	setIncludeFile (FileDef *fd, const DString &incName, bool local, bool force)=0
virtual void	setTemplateArguments (const ArgumentList &al)=0
virtual void	setNamespace (NamespaceDef *nd)=0
virtual void	setFileDef (FileDef *fd)=0
virtual void	writeTagFile (TextStream &)=0
virtual void	writeDocumentation (OutputList &ol)=0
virtual void	setInitializer (const DString &init)=0
virtual void	findSectionsInDocumentation ()=0
virtual void	setGroupId (int id)=0
virtual void	setModuleDef (ModuleDef *mod)=0
virtual void	addListReferences ()=0
virtual void	addRequirementReferences ()=0
virtual void	addDocPart (const DString &doc, int lineNr, size_t colNr)=0
virtual void	addCodePart (const DString &code, int lineNr, size_t colNr)=0
Public Member Functions inherited from DefinitionMutable
virtual void	setName (const DString &name)=0
virtual void	setId (const DString &name)=0
virtual void	setDefFile (const DString &df, int defLine, size_t defColumn)=0
virtual void	setDocumentation (const DString &d, const DString &docFile, int docLine, bool stripWhiteSpace=true)=0
virtual void	setBriefDescription (const DString &b, const DString &briefFile, int briefLine)=0
virtual void	setInbodyDocumentation (const DString &d, const DString &docFile, int docLine)=0
virtual void	setReference (const DString &r)=0
virtual void	setBodySegment (int defLine, int bls, int ble)=0
virtual void	setBodyDef (const FileDef *fd)=0
virtual void	setRefItems (const RefItemVector &sli)=0
virtual void	setRequirementReferences (const RequirementRefs &rqli)=0
virtual void	setOuterScope (Definition *d)=0
virtual void	setHidden (bool b)=0
virtual void	setArtificial (bool b)=0
virtual void	setExported (bool b)=0
virtual void	setLanguage (SrcLangExt lang)=0
virtual void	setLocalName (const DString &name)=0
virtual void	makePartOfGroup (GroupDef *gd)=0
virtual void	addSectionsToDefinition (const std::vector< const SectionInfo * > &anchorList)=0
virtual void	addSourceReferencedBy (MemberDef *d, const DString &sourceRefName)=0
virtual void	addSourceReferences (MemberDef *d, const DString &sourceRefName)=0
virtual void	mergeRefItems (Definition *d)=0
virtual void	addInnerCompound (Definition *d)=0
virtual void	mergeReferences (const Definition *other)=0
virtual void	mergeReferencedBy (const Definition *other)=0
virtual void	computeTooltip ()=0
virtual void	writeSourceDef (OutputList &ol) const =0
virtual void	writeInlineCode (OutputList &ol, const DString &scopeName) const =0
virtual bool	hasSourceRefs () const =0
virtual bool	hasSourceReffedBy () const =0
virtual void	writeSourceRefs (OutputList &ol, const DString &scopeName) const =0
virtual void	writeSourceReffedBy (OutputList &ol, const DString &scopeName) const =0
virtual bool	hasRequirementRefs () const =0
virtual void	writeRequirementRefs (OutputList &ol) const =0
virtual void	writeNavigationPath (OutputList &ol) const =0
virtual void	writeQuickMemberLinks (OutputList &, const MemberDef *) const =0
virtual void	writeSummaryLinks (OutputList &) const =0
virtual void	writePageNavigation (OutputList &) const =0
virtual void	writeDocAnchorsToTagFile (TextStream &) const =0
virtual void	writeToc (OutputList &ol, const LocalToc &lt) const =0
Public Member Functions inherited from ConceptDef
virtual bool	hasDetailedDescription () const =0
virtual const IncludeInfo *	includeInfo () const =0
virtual ArgumentList	getTemplateParameterList () const =0
virtual DString	initializer () const =0
virtual void	writeDeclarationLink (OutputList &ol, bool &found, const DString &header, bool localNames) const =0
virtual const NamespaceDef *	getNamespaceDef () const =0
virtual const FileDef *	getFileDef () const =0
virtual const ModuleDef *	getModuleDef () const =0
virtual DString	title () const =0
virtual int	groupId () const =0
virtual Parts	conceptParts () const =0
Public Member Functions inherited from Definition
virtual DefType	definitionType () const =0
virtual CodeSymbolType	codeSymbolType () const =0
virtual bool	isAlias () const =0
virtual const DString &	name () const =0
virtual bool	isAnonymous () const =0
virtual DString	displayName (bool includeScope=true) const =0
virtual const DString &	localName () const =0
virtual DString	qualifiedName () const =0
virtual DString	symbolName () const =0
virtual DString	getOutputFileBase () const =0
virtual DString	anchor () const =0
virtual DString	getSourceFileBase () const =0
virtual DString	getSourceAnchor () const =0
virtual DString	documentation () const =0
virtual int	docLine () const =0
virtual DString	docFile () const =0
virtual DString	briefDescription (bool abbreviate=false) const =0
virtual DString	briefDescriptionAsTooltip () const =0
virtual int	briefLine () const =0
virtual DString	briefFile () const =0
virtual DString	inbodyDocumentation () const =0
virtual DString	inbodyFile () const =0
virtual int	inbodyLine () const =0
virtual DString	getDefFileName () const =0
virtual DString	getDefFileExtension () const =0
virtual int	getDefLine () const =0
virtual size_t	getDefColumn () const =0
virtual bool	hasDocumentation () const =0
virtual bool	hasUserDocumentation () const =0
virtual bool	isLinkableInProject () const =0
virtual bool	isLinkable () const =0
virtual bool	isVisibleInProject () const =0
virtual bool	isVisible () const =0
virtual bool	isHidden () const =0
virtual bool	isArtificial () const =0
virtual bool	isExported () const =0
virtual DString	getReference () const =0
virtual bool	isReference () const =0
virtual DString	externalReference (const DString &relPath) const =0
virtual int	getStartDefLine () const =0
virtual int	getStartBodyLine () const =0
virtual int	getEndBodyLine () const =0
virtual const FileDef *	getBodyDef () const =0
virtual SrcLangExt	getLanguage () const =0
	Returns the programming language this definition was written in.
virtual const GroupList &	partOfGroups () const =0
virtual bool	isLinkableViaGroup () const =0
virtual const RefItemVector &	xrefListItems () const =0
virtual const RequirementRefs &	requirementReferences () const =0
virtual const Definition *	findInnerCompound (const DString &name) const =0
virtual Definition *	getOuterScope () const =0
virtual const MemberVector &	getReferencesMembers () const =0
virtual const MemberVector &	getReferencedByMembers () const =0
virtual bool	hasSections () const =0
virtual bool	hasSources () const =0
virtual bool	hasBriefDescription () const =0
	returns true if this class has a brief description
virtual DString	id () const =0
virtual const SectionRefs &	getSectionRefs () const =0
	returns the section dictionary, only of importance for pagedef
virtual DString	navigationPathAsString () const =0
virtual DString	pathFragment () const =0
virtual void	_setSymbolName (const DString &name)=0
virtual DString	_symbolName () const =0

Additional Inherited Members
Public Types inherited from ConceptDef
enum class	PartType { Code , Doc }
using	Parts = std::vector<Part>
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 }

Detailed Description

Definition at line 56 of file conceptdef.h.

Member Function Documentation

addCodePart()

virtual void ConceptDefMutable::addCodePart ( const DString & code, int lineNr, size_t colNr )

pure virtual

Implemented in ConceptDefImpl.

References addCodePart(), createConceptDef(), createConceptDefAlias(), and Definition::name().

Referenced by addCodePart(), and addConceptToContext().

addDocPart()

virtual void ConceptDefMutable::addDocPart ( const DString & doc, int lineNr, size_t colNr )

pure virtual

Implemented in ConceptDefImpl.

References addDocPart().

Referenced by addConceptToContext(), and addDocPart().

addListReferences()

virtual void ConceptDefMutable::addListReferences ( )

pure virtual

Implemented in ConceptDefImpl.

References addListReferences().

Referenced by addListReferences().

addRequirementReferences()

virtual void ConceptDefMutable::addRequirementReferences ( )

pure virtual

Implemented in ConceptDefImpl.

References addRequirementReferences().

Referenced by addRequirementReferences().

findSectionsInDocumentation()

virtual void ConceptDefMutable::findSectionsInDocumentation ( )

pure virtual

Implemented in ConceptDefImpl.

References findSectionsInDocumentation().

Referenced by findSectionsInDocumentation(), and findSectionsInDocumentation().

setFileDef()

virtual void ConceptDefMutable::setFileDef ( FileDef * fd )

pure virtual

Implemented in ConceptDefImpl.

References setFileDef().

Referenced by addConceptToContext(), and setFileDef().

setGroupId()

virtual void ConceptDefMutable::setGroupId ( int id )

pure virtual

Implemented in ConceptDefImpl.

References setGroupId().

Referenced by addConceptToContext(), and setGroupId().

setIncludeFile()

virtual void ConceptDefMutable::setIncludeFile ( FileDef * fd, const DString & incName, bool local, bool force )

pure virtual

Implemented in ConceptDefImpl.

References setIncludeFile().

Referenced by setIncludeFile().

setInitializer()

virtual void ConceptDefMutable::setInitializer ( const DString & init )

pure virtual

Implemented in ConceptDefImpl.

References setInitializer().

Referenced by addConceptToContext(), and setInitializer().

setModuleDef()

virtual void ConceptDefMutable::setModuleDef ( ModuleDef * mod )

pure virtual

Implemented in ConceptDefImpl.

References setModuleDef().

Referenced by setModuleDef().

setNamespace()

virtual void ConceptDefMutable::setNamespace ( NamespaceDef * nd )

pure virtual

Implemented in ConceptDefImpl.

References setNamespace().

Referenced by setNamespace().

setTemplateArguments()

virtual void ConceptDefMutable::setTemplateArguments ( const ArgumentList & al )

pure virtual

Implemented in ConceptDefImpl.

References setTemplateArguments().

Referenced by addConceptToContext(), and setTemplateArguments().

writeDocumentation()

virtual void ConceptDefMutable::writeDocumentation ( OutputList & ol )

pure virtual

Implemented in ConceptDefImpl.

References writeDocumentation().

Referenced by generateConceptDocs(), generateNamespaceConceptDocs(), and writeDocumentation().

writeTagFile()

virtual void ConceptDefMutable::writeTagFile ( TextStream & )

pure virtual

Implemented in ConceptDefImpl.

References writeTagFile().

Referenced by writeTagFile(), and writeTagFile().

---

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

• src/conceptdef.h