类 ConceptDefImpl 继承关系图:

ConceptDefImpl 的协作图:

Public 成员函数
	ConceptDefImpl (const QCString &fileName, int startLine, int startColumn, const QCString &name, const QCString &tagRef=QCString(), const QCString &tagFile=QCString())

	~ConceptDefImpl ()

virtual ConceptDef *	resolveAlias ()

virtual DefType	definitionType () const

virtual CodeSymbolType	codeSymbolType () const

virtual QCString	getOutputFileBase () const

virtual bool	hasDetailedDescription () const

virtual QCString	displayName (bool includeScope=true) const

virtual const IncludeInfo *	includeInfo () const

virtual ArgumentList	getTemplateParameterList () const

virtual QCString	anchor () const

virtual bool	isLinkableInProject () const

virtual bool	isLinkable () const

virtual QCString	initializer () const

virtual void	writeDeclarationLink (OutputList &ol, bool &found, const QCString &header, bool localNames) const

virtual const NamespaceDef *	getNamespaceDef () const

virtual const FileDef *	getFileDef () const

virtual QCString	title () const

virtual void	setIncludeFile (FileDef *fd, const QCString &incName, bool local, bool force)

virtual void	setTemplateArguments (const ArgumentList &al)

virtual void	setNamespace (NamespaceDef *nd)

virtual void	setFileDef (FileDef *fd)

virtual void	writeTagFile (TextStream &)

virtual void	writeDocumentation (OutputList &)

virtual void	setInitializer (const QCString &init)

virtual void	findSectionsInDocumentation ()

void	writeBriefDescription (OutputList &) const

void	writeAuthorSection (OutputList &ol) const

void	writeIncludeFiles (OutputList &ol) const

void	writeDetailedDescription (OutputList &ol, const QCString &title) const

void	writeDefinition (OutputList &ol, const QCString &title) const

Public 成员函数继承自 DefinitionMixin< ConceptDefMutable >
	DefinitionMixin (const QCString &defFileName, int defLine, int defColumn, const QCString &name, const char b=0, const char d=0, bool isSymbol=TRUE)

virtual	~DefinitionMixin ()

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 FileDef *	getBodyDef () const

virtual SrcLangExt	getLanguage () const

virtual const GroupList &	partOfGroups () const

virtual bool	isLinkableViaGroup () const

virtual const RefItemVector &	xrefListItems () const

virtual const Definition *	findInnerCompound (const QCString &name) const

virtual Definition *	getOuterScope () const

virtual const MemberVector &	getReferencesMembers () const

virtual const MemberVector &	getReferencedByMembers () const

virtual bool	hasSections () const

virtual bool	hasSources () const

virtual bool	hasBriefDescription () const

virtual QCString	id () const

virtual const SectionRefs &	getSectionRefs () 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 void	writeQuickMemberLinks (OutputList &ol, const MemberDef *md) const

virtual void	writeSummaryLinks (OutputList &ol) 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

Public 成员函数继承自 DefinitionMutable
virtual bool	hasSourceRefs () const =0

virtual bool	hasSourceReffedBy () const =0

virtual	~DefinitionMutable ()=default

Public 成员函数继承自 Definition
virtual bool	isAlias () const =0

virtual QCString	name () const =0

virtual bool	isAnonymous () const =0

virtual QCString	localName () const =0

virtual QCString	qualifiedName () const =0

virtual QCString	symbolName () const =0

virtual QCString	getSourceFileBase () const =0

virtual QCString	getSourceAnchor () const =0

virtual QCString	documentation () const =0

virtual int	docLine () const =0

virtual QCString	docFile () const =0

virtual QCString	briefDescriptionAsTooltip () const =0

virtual int	briefLine () const =0

virtual QCString	inbodyDocumentation () const =0

virtual QCString	inbodyFile () const =0

virtual int	inbodyLine () const =0

virtual QCString	briefFile () const =0

virtual QCString	getDefFileName () const =0

virtual QCString	getDefFileExtension () const =0

virtual int	getDefLine () const =0

virtual int	getDefColumn () const =0

virtual bool	hasDocumentation () const =0

virtual bool	hasUserDocumentation () const =0

virtual bool	isVisibleInProject () const =0

virtual bool	isVisible () const =0

virtual bool	isHidden () const =0

virtual bool	isArtificial () const =0

virtual QCString	getReference () const =0

virtual bool	isReference () 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 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 QCString	id () const =0

virtual const SectionRefs &	getSectionRefs () const =0
	returns the section dictionary, only of importance for pagedef 更多...

virtual QCString	navigationPathAsString () const =0

virtual QCString	pathFragment () const =0

virtual QCString	_symbolName () const =0

virtual	~Definition ()=default

Private 属性
QCString	m_fileName

std::unique_ptr< IncludeInfo >	m_incInfo

NamespaceDef *	m_nspace = 0

FileDef *	m_fileDef = 0

ArgumentList	m_tArgList

QCString	m_initializer

额外继承的成员函数
Public 类型继承自 Definition
enum	DefType { TypeClass = 0, TypeFile = 1, TypeNamespace = 2, TypeMember = 3, TypeGroup = 4, TypePackage = 5, TypePage = 6, TypeDir = 7, TypeConcept = 8 }

Protected 成员函数继承自 DefinitionMixin< ConceptDefMutable >
	DefinitionMixin (const DefinitionMixin &def)=default

详细描述

在文件 conceptdef.cpp 第 31 行定义.

构造及析构函数说明

◆ ConceptDefImpl()

ConceptDefImpl::ConceptDefImpl	(	const QCString &	fileName,
		int	startLine,
		int	startColumn,
		const QCString &	name,
		const QCString &	tagRef = `QCString()`,
		const QCString &	tagFile = `QCString()`
	)

在文件 conceptdef.cpp 第 147 行定义.

                                                                          : DefinitionMixin(fileName,startLine,startColumn,name)
 {
   if (!tagFile.isEmpty())
   {
     if (!tagRef.isEmpty())
     {
       m_fileName = stripExtension(tagFile);
     }
     else
     {
       m_fileName = convertNameToFile(stripExtension(tagFile));
     }
   }
   else
   {
     m_fileName = convertNameToFile(QCString("concept")+name);
   }
   setReference(tagRef);
 }

引用了 convertNameToFile(), QCString::isEmpty(), m_fileName, DefinitionMixin< ConceptDefMutable >::name(), DefinitionMixin< ConceptDefMutable >::setReference() , 以及 stripExtension().

◆ ~ConceptDefImpl()

ConceptDefImpl::~ConceptDefImpl ( )

在文件 conceptdef.cpp 第 168 行定义.

169 {

170 }

成员函数说明

◆ anchor()

QCString ConceptDefImpl::anchor ( ) const

virtual

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

实现了 ConceptDef.

在文件 conceptdef.cpp 第 191 行定义.

 {
   return "";
 }

被这些函数引用 writeDeclarationLink().

◆ codeSymbolType()

virtual CodeSymbolType ConceptDefImpl::codeSymbolType ( ) const

inlinevirtual

Used for syntax highlighting symbol class

实现了 Definition.

在文件 conceptdef.cpp 第 55 行定义.

75 :

76 QCString m_fileName;

◆ definitionType()

Definition::DefType ConceptDefImpl::definitionType ( ) const

virtual

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

实现了 ConceptDef.

在文件 conceptdef.cpp 第 172 行定义.

 {
   return TypeConcept;
 }

引用了 Definition::TypeConcept.

◆ displayName()

QCString ConceptDefImpl::displayName ( bool includeScope = true ) const

virtual

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

实现了 ConceptDef.

在文件 conceptdef.cpp 第 196 行定义.

 {
   return includeScope ? name() : localName();
 }

引用了 DefinitionMixin< ConceptDefMutable >::localName() , 以及 DefinitionMixin< ConceptDefMutable >::name().

被这些函数引用 title(), writeDeclarationLink() , 以及 writeDocumentation().

◆ findSectionsInDocumentation()

void ConceptDefImpl::findSectionsInDocumentation ( )

virtual

实现了 ConceptDefMutable.

在文件 conceptdef.cpp 第 640 行定义.

 {
   docFindSections(briefDescription(),this,docFile());
   docFindSections(documentation(),this,docFile());
 }

引用了 DefinitionMixin< ConceptDefMutable >::briefDescription(), DefinitionMixin< ConceptDefMutable >::docFile(), docFindSections() , 以及 DefinitionMixin< ConceptDefMutable >::documentation().

◆ getFileDef()

const FileDef * ConceptDefImpl::getFileDef ( ) const

virtual

实现了 ConceptDef.

在文件 conceptdef.cpp 第 259 行定义.

 {
   return m_fileDef;
 }

引用了 m_fileDef.

◆ getNamespaceDef()

const NamespaceDef * ConceptDefImpl::getNamespaceDef ( ) const

virtual

实现了 ConceptDef.

在文件 conceptdef.cpp 第 249 行定义.

 {
   return m_nspace;
 }

引用了 m_nspace.

◆ getOutputFileBase()

QCString ConceptDefImpl::getOutputFileBase ( ) const

virtual

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

实现了 ConceptDef.

在文件 conceptdef.cpp 第 177 行定义.

 {
   return m_fileName;
 }

引用了 m_fileName.

被这些函数引用 writeBriefDescription(), writeDeclarationLink(), writeDocumentation() , 以及 writeTagFile().

◆ getTemplateParameterList()

ArgumentList ConceptDefImpl::getTemplateParameterList ( ) const

virtual

实现了 ConceptDef.

在文件 conceptdef.cpp 第 206 行定义.

 {
   return m_tArgList;
 }

引用了 m_tArgList.

◆ hasDetailedDescription()

bool ConceptDefImpl::hasDetailedDescription ( ) const

virtual

实现了 ConceptDef.

在文件 conceptdef.cpp 第 182 行定义.

 {
   bool repeatBrief = Config_getBool(REPEAT_BRIEF);
   bool sourceBrowser = Config_getBool(SOURCE_BROWSER);
   return ((!briefDescription().isEmpty() && repeatBrief) ||
           !documentation().isEmpty() ||
           (sourceBrowser && getStartBodyLine()!=-1 && getBodyDef()));
 }

引用了 DefinitionMixin< ConceptDefMutable >::briefDescription(), Config_getBool, DefinitionMixin< ConceptDefMutable >::documentation(), DefinitionMixin< ConceptDefMutable >::getBodyDef() , 以及 DefinitionMixin< ConceptDefMutable >::getStartBodyLine().

被这些函数引用 writeBriefDescription() , 以及 writeDetailedDescription().

◆ includeInfo()

const IncludeInfo * ConceptDefImpl::includeInfo ( ) const

virtual

实现了 ConceptDef.

在文件 conceptdef.cpp 第 201 行定义.

 {
   return m_incInfo.get();
 }

引用了 m_incInfo.

◆ initializer()

QCString ConceptDefImpl::initializer ( ) const

virtual

实现了 ConceptDef.

在文件 conceptdef.cpp 第 389 行定义.

 {
   return m_initializer;
 }

引用了 m_initializer.

◆ isLinkable()

bool ConceptDefImpl::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.

实现了 ConceptDef.

在文件 conceptdef.cpp 第 216 行定义.

 {
   return isLinkableInProject() || isReference();
 }

引用了 isLinkableInProject() , 以及 DefinitionMixin< ConceptDefMutable >::isReference().

被这些函数引用 writeDeclarationLink().

◆ isLinkableInProject()

bool ConceptDefImpl::isLinkableInProject ( ) const

virtual

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

实现了 ConceptDef.

在文件 conceptdef.cpp 第 211 行定义.

 {
   return hasDocumentation() && !isReference() && !isHidden();
 }

引用了 DefinitionMixin< ConceptDefMutable >::hasDocumentation(), DefinitionMixin< ConceptDefMutable >::isHidden() , 以及 DefinitionMixin< ConceptDefMutable >::isReference().

被这些函数引用 isLinkable().

◆ resolveAlias()

virtual ConceptDef* ConceptDefImpl::resolveAlias ( )

inlinevirtual

在文件 conceptdef.cpp 第 51 行定义.

75 :

76 QCString m_fileName;

◆ setFileDef()

void ConceptDefImpl::setFileDef ( FileDef * fd )

virtual

实现了 ConceptDefMutable.

在文件 conceptdef.cpp 第 254 行定义.

 {
   m_fileDef=fd;
 }

引用了 m_fileDef.

◆ setIncludeFile()

void ConceptDefImpl::setIncludeFile	(	FileDef *	fd,
		const QCString &	incName,
		bool	local,
		bool	force
	)

virtual

实现了 ConceptDefMutable.

在文件 conceptdef.cpp 第 221 行定义.

 {
   if (!m_incInfo) m_incInfo = std::make_unique<IncludeInfo>();
   if ((!incName.isEmpty() && m_incInfo->includeName.isEmpty()) ||
       (fd!=0 && m_incInfo->fileDef==0)
      )
   {
     m_incInfo->fileDef     = fd;
     m_incInfo->includeName = incName;
     m_incInfo->local       = local;
   }
   if (force && !incName.isEmpty())
   {
     m_incInfo->includeName = incName;
     m_incInfo->local       = local;
   }
 }

引用了 QCString::isEmpty() , 以及 m_incInfo.

◆ setInitializer()

void ConceptDefImpl::setInitializer ( const QCString & init )

virtual

实现了 ConceptDefMutable.

在文件 conceptdef.cpp 第 384 行定义.

 {
   m_initializer = templateSpec(m_tArgList)+"\nconcept "+name()+" = "+init;
 }

引用了 Config::init(), m_initializer, m_tArgList, DefinitionMixin< ConceptDefMutable >::name() , 以及 templateSpec().

◆ setNamespace()

void ConceptDefImpl::setNamespace ( NamespaceDef * nd )

virtual

实现了 ConceptDefMutable.

在文件 conceptdef.cpp 第 244 行定义.

 {
   m_nspace = nd;
 }

引用了 m_nspace.

◆ setTemplateArguments()

void ConceptDefImpl::setTemplateArguments ( const ArgumentList & al )

virtual

实现了 ConceptDefMutable.

在文件 conceptdef.cpp 第 239 行定义.

 {
   m_tArgList = al;
 }

引用了 m_tArgList.

◆ title()

QCString ConceptDefImpl::title ( ) const

virtual

实现了 ConceptDef.

在文件 conceptdef.cpp 第 264 行定义.

 {
   return theTranslator->trConceptReference(displayName());
 }

引用了 displayName(), theTranslator , 以及 Translator::trConceptReference().

被这些函数引用 writeDefinition() , 以及 writeDetailedDescription().

◆ writeAuthorSection()

void ConceptDefImpl::writeAuthorSection ( OutputList & ol ) const

在文件 conceptdef.cpp 第 459 行定义.

 {
   // write Author section (Man only)
   ol.pushGeneratorState();
   ol.disableAllBut(OutputGenerator::Man);
   ol.startGroupHeader();
   ol.parseText(theTranslator->trAuthor(TRUE,TRUE));
   ol.endGroupHeader();
   ol.parseText(theTranslator->trGeneratedAutomatically(Config_getString(PROJECT_NAME)));
   ol.popGeneratorState();
 }

引用了 Config_getString, OutputList::disableAllBut(), OutputList::endGroupHeader(), OutputGenerator::Man, OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), OutputList::startGroupHeader(), theTranslator, Translator::trAuthor(), Translator::trGeneratedAutomatically() , 以及 TRUE.

被这些函数引用 writeDocumentation().

◆ writeBriefDescription()

void ConceptDefImpl::writeBriefDescription ( OutputList & ol ) const

在文件 conceptdef.cpp 第 283 行定义.

 {
   if (hasBriefDescription())
   {
     std::unique_ptr<IDocParser> parser { createDocParser() };
     std::unique_ptr<DocRoot>  rootNode { validatingParseDoc(
                         *parser.get(),briefFile(),briefLine(),this,0,
                         briefDescription(),TRUE,FALSE,
                         QCString(),TRUE,FALSE,Config_getBool(MARKDOWN_SUPPORT)) };
     if (rootNode && !rootNode->isEmpty())
     {
       ol.startParagraph();
       ol.pushGeneratorState();
       ol.disableAllBut(OutputGenerator::Man);
       ol.writeString(" - ");
       ol.popGeneratorState();
       ol.writeDoc(rootNode.get(),this,0);
       ol.pushGeneratorState();
       ol.disable(OutputGenerator::RTF);
       ol.writeString(" \n");
       ol.enable(OutputGenerator::RTF);
  
       if (hasDetailedDescription())
       {
         ol.disableAllBut(OutputGenerator::Html);
         ol.startTextLink(getOutputFileBase(),"details");
         ol.parseText(theTranslator->trMore());
         ol.endTextLink();
       }
       ol.popGeneratorState();
       ol.endParagraph();
     }
   }
   ol.writeSynopsis();
 }

引用了 DefinitionMixin< ConceptDefMutable >::briefDescription(), DefinitionMixin< ConceptDefMutable >::briefFile(), DefinitionMixin< ConceptDefMutable >::briefLine(), Config_getBool, createDocParser(), OutputList::disable(), OutputList::disableAllBut(), OutputList::enable(), OutputList::endParagraph(), OutputList::endTextLink(), FALSE, getOutputFileBase(), DefinitionMixin< ConceptDefMutable >::hasBriefDescription(), hasDetailedDescription(), OutputGenerator::Html, OutputGenerator::Man, OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), OutputGenerator::RTF, OutputList::startParagraph(), OutputList::startTextLink(), theTranslator, Translator::trMore(), TRUE, validatingParseDoc(), OutputList::writeDoc(), OutputList::writeString() , 以及 OutputList::writeSynopsis().

被这些函数引用 writeDocumentation().

◆ writeDeclarationLink()

void ConceptDefImpl::writeDeclarationLink	(	OutputList &	ol,
		bool &	found,
		const QCString &	header,
		bool	localNames
	)		const

virtual

实现了 ConceptDef.

在文件 conceptdef.cpp 第 582 行定义.

 {
   if (isLinkable())
   {
     if (!found) // first concept
     {
       ol.startMemberHeader("concepts");
       if (!header.isEmpty())
       {
         ol.parseText(header);
       }
       else
       {
         theTranslator->trConcept(true,false);
       }
       ol.endMemberHeader();
       ol.startMemberList();
       found=TRUE;
     }
     ol.startMemberDeclaration();
     ol.startMemberItem(anchor(),FALSE);
     ol.writeString("concept ");
     QCString cname = displayName(!localNames);
     ol.insertMemberAlign();
     if (isLinkable())
     {
       ol.writeObjectLink(getReference(),
           getOutputFileBase(),
           anchor(),
           cname
           );
     }
     else
     {
       ol.startBold();
       ol.docify(cname);
       ol.endBold();
     }
     ol.endMemberItem();
     // add the brief description if available
     if (!briefDescription().isEmpty() && Config_getBool(BRIEF_MEMBER_DESC))
     {
       std::unique_ptr<IDocParser> parser { createDocParser() };
       std::unique_ptr<DocRoot>  rootNode { validatingParseDoc(
                                 *parser.get(),briefFile(),briefLine(),this,0,
                                 briefDescription(),FALSE,FALSE,
                                 QCString(),TRUE,FALSE,Config_getBool(MARKDOWN_SUPPORT)) };
       if (rootNode && !rootNode->isEmpty())
       {
         ol.startMemberDescription(anchor());
         ol.writeDoc(rootNode.get(),this,0);
         ol.endMemberDescription();
       }
     }
     ol.endMemberDeclaration(anchor(),QCString());
   }
 }

引用了 anchor(), DefinitionMixin< ConceptDefMutable >::briefDescription(), DefinitionMixin< ConceptDefMutable >::briefFile(), DefinitionMixin< ConceptDefMutable >::briefLine(), Config_getBool, createDocParser(), displayName(), OutputList::docify(), OutputList::endBold(), OutputList::endMemberDeclaration(), OutputList::endMemberDescription(), OutputList::endMemberHeader(), OutputList::endMemberItem(), FALSE, getOutputFileBase(), DefinitionMixin< ConceptDefMutable >::getReference(), OutputList::insertMemberAlign(), QCString::isEmpty(), isLinkable(), OutputList::parseText(), OutputList::startBold(), OutputList::startMemberDeclaration(), OutputList::startMemberDescription(), OutputList::startMemberHeader(), OutputList::startMemberItem(), OutputList::startMemberList(), theTranslator, Translator::trConcept(), TRUE, validatingParseDoc(), OutputList::writeDoc(), OutputList::writeObjectLink() , 以及 OutputList::writeString().

◆ writeDefinition()

void ConceptDefImpl::writeDefinition	(	OutputList &	ol,
		const QCString &	title
	)		const

在文件 conceptdef.cpp 第 394 行定义.

 {
     ol.startGroupHeader();
       ol.parseText(title);
     ol.endGroupHeader();
  
     auto intf = Doxygen::parserManager->getCodeParser(".cpp");
     intf->resetCodeParserState();
     ol.startCodeFragment("DoxyCode");
     QCString scopeName;
     if (getOuterScope()!=Doxygen::globalScope) scopeName=getOuterScope()->name();
     TextStream conceptDef;
     conceptDef << m_initializer;
     intf->parseCode(ol,scopeName,conceptDef.str(),SrcLangExt_Cpp,false,QCString(),
                     m_fileDef, -1,-1,true,0,false,this);
     ol.endCodeFragment("DoxyCode");
 }

引用了 OutputList::endCodeFragment(), OutputList::endGroupHeader(), ParserManager::getCodeParser(), DefinitionMixin< ConceptDefMutable >::getOuterScope(), Doxygen::globalScope, m_fileDef, m_initializer, Definition::name(), Doxygen::parserManager, OutputList::parseText(), SrcLangExt_Cpp, OutputList::startCodeFragment(), OutputList::startGroupHeader(), TextStream::str() , 以及 title().

被这些函数引用 writeDocumentation().

◆ writeDetailedDescription()

void ConceptDefImpl::writeDetailedDescription	(	OutputList &	ol,
		const QCString &	title
	)		const

在文件 conceptdef.cpp 第 412 行定义.

 {
   static bool repeatBrief = Config_getBool(REPEAT_BRIEF);
   if (hasDetailedDescription())
   {
     ol.pushGeneratorState();
       ol.disable(OutputGenerator::Html);
       ol.writeRuler();
     ol.popGeneratorState();
  
     ol.pushGeneratorState();
       ol.disableAllBut(OutputGenerator::Html);
       ol.writeAnchor(QCString(),"details");
     ol.popGeneratorState();
  
     ol.startGroupHeader();
       ol.parseText(title);
     ol.endGroupHeader();
  
     ol.startTextBlock();
     // repeat brief description
     if (!briefDescription().isEmpty() && repeatBrief)
     {
       ol.generateDoc(briefFile(),briefLine(),this,0,briefDescription(),FALSE,FALSE,
           QCString(),FALSE,FALSE,Config_getBool(MARKDOWN_SUPPORT));
     }
     if (!briefDescription().isEmpty() && repeatBrief &&
         !documentation().isEmpty())
     {
       ol.pushGeneratorState();
       ol.disable(OutputGenerator::Html);
       ol.writeString("\n\n");
       ol.popGeneratorState();
     }
  
     // write documentation
     if (!documentation().isEmpty())
     {
       ol.generateDoc(docFile(),docLine(),this,0,documentation(),TRUE,FALSE,
           QCString(),FALSE,FALSE,Config_getBool(MARKDOWN_SUPPORT));
     }
  
     writeSourceDef(ol,name());
     ol.endTextBlock();
   }
 }

引用了 DefinitionMixin< ConceptDefMutable >::briefDescription(), DefinitionMixin< ConceptDefMutable >::briefFile(), DefinitionMixin< ConceptDefMutable >::briefLine(), Config_getBool, OutputList::disable(), OutputList::disableAllBut(), DefinitionMixin< ConceptDefMutable >::docFile(), DefinitionMixin< ConceptDefMutable >::docLine(), DefinitionMixin< ConceptDefMutable >::documentation(), OutputList::endGroupHeader(), OutputList::endTextBlock(), FALSE, OutputList::generateDoc(), hasDetailedDescription(), OutputGenerator::Html, DefinitionMixin< ConceptDefMutable >::name(), OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), OutputList::startGroupHeader(), OutputList::startTextBlock(), title(), TRUE, OutputList::writeAnchor(), OutputList::writeRuler(), DefinitionMixin< ConceptDefMutable >::writeSourceDef() , 以及 OutputList::writeString().

被这些函数引用 writeDocumentation().

◆ writeDocumentation()

void ConceptDefImpl::writeDocumentation ( OutputList & ol )

virtual

实现了 ConceptDefMutable.

在文件 conceptdef.cpp 第 471 行定义.

 {
   static bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);
   QCString pageTitle = theTranslator->trConceptReference(displayName());
   startFile(ol,getOutputFileBase(),name(),pageTitle,HLI_ConceptVisible,!generateTreeView);
  
   // ---- navigation part
   if (!generateTreeView)
   {
     if (getOuterScope()!=Doxygen::globalScope)
     {
       writeNavigationPath(ol);
     }
     ol.endQuickIndices();
   }
  
   // ---- title part
   startTitle(ol,getOutputFileBase(),this);
   ol.parseText(pageTitle);
   addGroupListToTitle(ol,this);
   endTitle(ol,getOutputFileBase(),displayName());
  
   // ---- contents part
  
   ol.startContents();
  
   //---------------------------------------- start flexible part -------------------------------
  
   for (const auto &lde : LayoutDocManager::instance().docEntries(LayoutDocManager::Concept))
   {
     switch (lde->kind())
     {
       case LayoutDocEntry::BriefDesc:
         writeBriefDescription(ol);
         break;
       case LayoutDocEntry::ConceptDefinition:
         {
           const LayoutDocEntrySection *ls = (const LayoutDocEntrySection*)lde.get();
           writeDefinition(ol,ls->title(getLanguage()));
         }
         break;
       case LayoutDocEntry::DetailedDesc:
         {
           const LayoutDocEntrySection *ls = (const LayoutDocEntrySection*)lde.get();
           writeDetailedDescription(ol,ls->title(getLanguage()));
         }
         break;
       case LayoutDocEntry::AuthorSection:
         writeAuthorSection(ol);
         break;
       case LayoutDocEntry::ClassIncludes:
         writeIncludeFiles(ol);
         break;
       case LayoutDocEntry::MemberDeclStart:
       case LayoutDocEntry::NamespaceClasses:
       case LayoutDocEntry::NamespaceInterfaces:
       case LayoutDocEntry::NamespaceStructs:
       case LayoutDocEntry::NamespaceExceptions:
       case LayoutDocEntry::NamespaceConcepts:
       case LayoutDocEntry::NamespaceNestedNamespaces:
       case LayoutDocEntry::NamespaceNestedConstantGroups:
       case LayoutDocEntry::MemberGroups:
       case LayoutDocEntry::MemberDecl:
       case LayoutDocEntry::MemberDeclEnd:
       case LayoutDocEntry::MemberDefStart:
       case LayoutDocEntry::NamespaceInlineClasses:
       case LayoutDocEntry::MemberDef:
       case LayoutDocEntry::MemberDefEnd:
       case LayoutDocEntry::ClassInheritanceGraph:
       case LayoutDocEntry::ClassNestedClasses:
       case LayoutDocEntry::ClassCollaborationGraph:
       case LayoutDocEntry::ClassAllMembersLink:
       case LayoutDocEntry::ClassUsedFiles:
       case LayoutDocEntry::ClassInlineClasses:
       case LayoutDocEntry::FileClasses:
       case LayoutDocEntry::FileConcepts:
       case LayoutDocEntry::FileInterfaces:
       case LayoutDocEntry::FileStructs:
       case LayoutDocEntry::FileExceptions:
       case LayoutDocEntry::FileNamespaces:
       case LayoutDocEntry::FileConstantGroups:
       case LayoutDocEntry::FileIncludes:
       case LayoutDocEntry::FileIncludeGraph:
       case LayoutDocEntry::FileIncludedByGraph:
       case LayoutDocEntry::FileInlineClasses:
       case LayoutDocEntry::FileSourceLink:
       case LayoutDocEntry::GroupClasses:
       case LayoutDocEntry::GroupConcepts:
       case LayoutDocEntry::GroupInlineClasses:
       case LayoutDocEntry::GroupNamespaces:
       case LayoutDocEntry::GroupDirs:
       case LayoutDocEntry::GroupNestedGroups:
       case LayoutDocEntry::GroupFiles:
       case LayoutDocEntry::GroupGraph:
       case LayoutDocEntry::GroupPageDocs:
       case LayoutDocEntry::DirSubDirs:
       case LayoutDocEntry::DirFiles:
       case LayoutDocEntry::DirGraph:
         err("Internal inconsistency: member %d should not be part of "
             "LayoutDocManager::Namespace entry list\n",lde->kind());
         break;
     }
   }
  
   //---------------------------------------- end flexible part -------------------------------
  
   ol.endContents();
  
   endFileWithNavPath(this,ol);
 }

◆ writeIncludeFiles()

void ConceptDefImpl::writeIncludeFiles ( OutputList & ol ) const

在文件 conceptdef.cpp 第 319 行定义.

 {
   if (m_incInfo)
   {
     QCString nm=m_incInfo->includeName.isEmpty() ?
       (m_incInfo->fileDef ?
        m_incInfo->fileDef->docName() : QCString()
       ) :
       m_incInfo->includeName;
     if (!nm.isEmpty())
     {
       ol.startParagraph();
       ol.startTypewriter();
       ol.docify("#include ");
       if (m_incInfo->local)
         ol.docify("\"");
       else
         ol.docify("<");
       ol.pushGeneratorState();
       ol.disable(OutputGenerator::Html);
       ol.docify(nm);
       ol.disableAllBut(OutputGenerator::Html);
       ol.enable(OutputGenerator::Html);
       if (m_incInfo->fileDef)
       {
         ol.writeObjectLink(QCString(),m_incInfo->fileDef->includeName(),QCString(),nm);
       }
       else
       {
         ol.docify(nm);
       }
       ol.popGeneratorState();
       if (m_incInfo->local)
         ol.docify("\"");
       else
         ol.docify(">");
       ol.endTypewriter();
       ol.endParagraph();
     }
   }
 }

引用了 OutputList::disable(), OutputList::disableAllBut(), OutputList::docify(), OutputList::enable(), OutputList::endParagraph(), OutputList::endTypewriter(), OutputGenerator::Html, QCString::isEmpty(), m_incInfo, OutputList::popGeneratorState(), OutputList::pushGeneratorState(), OutputList::startParagraph(), OutputList::startTypewriter() , 以及 OutputList::writeObjectLink().

被这些函数引用 writeDocumentation().

◆ writeTagFile()

void ConceptDefImpl::writeTagFile ( TextStream & tagFile )

virtual

实现了 ConceptDefMutable.

在文件 conceptdef.cpp 第 269 行定义.

 {
   tagFile << "  <compound kind=\"concept\">\n";
   tagFile << "    <name>" << convertToXML(name()) << "</name>\n";
   tagFile << "    <filename>" << convertToXML(addHtmlExtensionIfMissing(getOutputFileBase())) << "</filename>\n";
   QCString idStr = id();
   if (!idStr.isEmpty())
   {
     tagFile << "    <clangid>" << convertToXML(idStr) << "</clangid>\n";
   }
   writeDocAnchorsToTagFile(tagFile);
   tagFile << "  </compound>\n";
 }

引用了 addHtmlExtensionIfMissing(), convertToXML(), getOutputFileBase(), DefinitionMixin< ConceptDefMutable >::id(), QCString::isEmpty(), DefinitionMixin< ConceptDefMutable >::name() , 以及 DefinitionMixin< ConceptDefMutable >::writeDocAnchorsToTagFile().

类成员变量说明

◆ m_fileDef

FileDef* ConceptDefImpl::m_fileDef = 0

private

在文件 conceptdef.cpp 第 92 行定义.

被这些函数引用 getFileDef(), setFileDef() , 以及 writeDefinition().

◆ m_fileName

QCString ConceptDefImpl::m_fileName

private

在文件 conceptdef.cpp 第 89 行定义.

被这些函数引用 ConceptDefImpl() , 以及 getOutputFileBase().

◆ m_incInfo

std::unique_ptr<IncludeInfo> ConceptDefImpl::m_incInfo

private

在文件 conceptdef.cpp 第 90 行定义.

被这些函数引用 includeInfo(), setIncludeFile() , 以及 writeIncludeFiles().

◆ m_initializer

QCString ConceptDefImpl::m_initializer

private

在文件 conceptdef.cpp 第 94 行定义.

被这些函数引用 initializer(), setInitializer() , 以及 writeDefinition().

◆ m_nspace

NamespaceDef* ConceptDefImpl::m_nspace = 0

private

在文件 conceptdef.cpp 第 91 行定义.

被这些函数引用 getNamespaceDef() , 以及 setNamespace().

◆ m_tArgList

ArgumentList ConceptDefImpl::m_tArgList

private

在文件 conceptdef.cpp 第 93 行定义.

被这些函数引用 getTemplateParameterList(), setInitializer() , 以及 setTemplateArguments().

该类的文档由以下文件生成:

src/conceptdef.cpp

Public 成员函数

Private 属性

额外继承的成员函数

详细描述

构造及析构函数说明

◆ ConceptDefImpl()

◆ ~ConceptDefImpl()

成员函数说明

◆ anchor()

◆ codeSymbolType()

◆ definitionType()

◆ displayName()

◆ findSectionsInDocumentation()

◆ getFileDef()

◆ getNamespaceDef()

◆ getOutputFileBase()

◆ getTemplateParameterList()

◆ hasDetailedDescription()

◆ includeInfo()

◆ initializer()

◆ isLinkable()

◆ isLinkableInProject()

◆ resolveAlias()

◆ setFileDef()

◆ setIncludeFile()

◆ setInitializer()

◆ setNamespace()

◆ setTemplateArguments()

◆ title()

◆ writeAuthorSection()

◆ writeBriefDescription()

◆ writeDeclarationLink()

◆ writeDefinition()

◆ writeDetailedDescription()

◆ writeDocumentation()

◆ writeIncludeFiles()

◆ writeTagFile()

类成员变量说明

◆ m_fileDef

◆ m_fileName

◆ m_incInfo

◆ m_initializer

◆ m_nspace

◆ m_tArgList