类 PageDefImpl 继承关系图:

PageDefImpl 的协作图:

Public 成员函数
	PageDefImpl (const QCString &f, int l, const QCString &n, const QCString &d, const QCString &t)

virtual	~PageDefImpl ()

virtual void	setFileName (const QCString &name)

virtual void	setLocalToc (const LocalToc &tl)

virtual void	setShowLineNo (bool)

virtual DefType	definitionType () const

virtual CodeSymbolType	codeSymbolType () const

virtual bool	isLinkableInProject () const

virtual bool	isLinkable () const

virtual QCString	getOutputFileBase () const

virtual QCString	anchor () const

virtual void	findSectionsInDocumentation ()

virtual QCString	title () const

virtual const GroupDef *	getGroupDef () const

virtual const PageLinkedRefMap &	getSubPages () const

virtual void	addInnerCompound (const Definition *d)

virtual bool	visibleInIndex () const

virtual bool	documentedPage () const

virtual bool	hasSubPages () const

virtual bool	hasParentPage () const

virtual bool	hasTitle () const

virtual LocalToc	localToc () const

virtual void	setPageScope (Definition *d)

virtual Definition *	getPageScope () const

virtual QCString	displayName (bool=TRUE) const

virtual bool	showLineNo () const

virtual void	setTitle (const QCString &title)

virtual void	writeDocumentation (OutputList &ol)

virtual void	writeTagFile (TextStream &)

virtual void	setNestingLevel (int l)

virtual void	writePageDocumentation (OutputList &ol) const

Public 成员函数继承自 DefinitionMixin< PageDef >
	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	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 成员函数继承自 PageDef
virtual	~PageDef ()

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

QCString	m_title

PageLinkedRefMap	m_subPages

Definition *	m_pageScope

int	m_nestingLevel

LocalToc	m_localToc

bool	m_showLineNo

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

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

详细描述

在文件 pagedef.cpp 第 30 行定义.

构造及析构函数说明

◆ PageDefImpl()

PageDefImpl::PageDefImpl	(	const QCString &	f,
		int	l,
		const QCString &	n,
		const QCString &	d,
		const QCString &	t
	)

在文件 pagedef.cpp 第 83 行定义.

  : DefinitionMixin(f,l,1,n), m_title(!t.isEmpty() ? t : n)
 {
   setDocumentation(d,f,l);
   m_pageScope = 0;
   m_nestingLevel = 0;
   m_fileName = ::convertNameToFile(n,FALSE,TRUE);
   m_showLineNo = FALSE;
 }

◆ ~PageDefImpl()

PageDefImpl::~PageDefImpl ( )

virtual

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

95 {

96 }

成员函数说明

◆ addInnerCompound()

void PageDefImpl::addInnerCompound ( const Definition * d )

virtual

重载 DefinitionMixin< PageDef > .

在文件 pagedef.cpp 第 122 行定义.

 {
   if (def->definitionType()==Definition::TypePage)
   {
     PageDef *pd = const_cast<PageDef*>(toPageDef(def));
     if (pd)
     {
       m_subPages.add(pd->name(),pd);
       pd->setOuterScope(this);
       if (this==Doxygen::mainPage.get())
       {
         pd->setNestingLevel(m_nestingLevel);
       }
       else
       {
         pd->setNestingLevel(m_nestingLevel+1);
       }
     }
   }
 }

引用了 LinkedRefMap< T, Hash, KeyEqual, Map >::add(), Definition::definitionType(), m_nestingLevel, m_subPages, Doxygen::mainPage, Definition::name(), PageDef::setNestingLevel(), DefinitionMutable::setOuterScope(), toPageDef() , 以及 Definition::TypePage.

◆ anchor()

virtual QCString PageDefImpl::anchor ( ) const

inlinevirtual

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

实现了 PageDef.

在文件 pagedef.cpp 第 57 行定义.

57 { return m_pageScope; }

引用了 m_pageScope.

◆ codeSymbolType()

virtual CodeSymbolType PageDefImpl::codeSymbolType ( ) const

inlinevirtual

Used for syntax highlighting symbol class

实现了 Definition.

在文件 pagedef.cpp 第 53 行定义.

55 { return m_localToc; }

◆ definitionType()

virtual DefType PageDefImpl::definitionType ( ) const

inlinevirtual

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

实现了 PageDef.

在文件 pagedef.cpp 第 52 行定义.

55 { return m_localToc; }

◆ displayName()

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

inlinevirtual

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

实现了 PageDef.

在文件 pagedef.cpp 第 71 行定义.

77 {

◆ documentedPage()

bool PageDefImpl::documentedPage ( ) const

virtual

实现了 PageDef.

在文件 pagedef.cpp 第 363 行定义.

 {
    return // not part of a group
           !getGroupDef() &&
           // not an externally defined page
           !isReference();
 }

引用了 getGroupDef() , 以及 DefinitionMixin< PageDef >::isReference().

◆ findSectionsInDocumentation()

void PageDefImpl::findSectionsInDocumentation ( )

virtual

实现了 PageDef.

在文件 pagedef.cpp 第 98 行定义.

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

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

◆ getGroupDef()

const GroupDef * PageDefImpl::getGroupDef ( ) const

virtual

实现了 PageDef.

在文件 pagedef.cpp 第 104 行定义.

 {
   return !partOfGroups().empty() ? partOfGroups().front() : 0;
 }

引用了 DefinitionMixin< PageDef >::partOfGroups().

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

◆ getOutputFileBase()

QCString PageDefImpl::getOutputFileBase ( ) const

virtual

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

实现了 PageDef.

在文件 pagedef.cpp 第 109 行定义.

 {
   if (getGroupDef())
     return getGroupDef()->getOutputFileBase();
   else
     return m_fileName;
 }

引用了 getGroupDef(), GroupDef::getOutputFileBase() , 以及 m_fileName.

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

◆ getPageScope()

virtual Definition* PageDefImpl::getPageScope ( ) const

inlinevirtual

实现了 PageDef.

在文件 pagedef.cpp 第 70 行定义.

77 {

◆ getSubPages()

virtual const PageLinkedRefMap& PageDefImpl::getSubPages ( ) const

inlinevirtual

实现了 PageDef.

在文件 pagedef.cpp 第 61 行定义.

66 :

67 QCString m_fileName;

◆ hasParentPage()

bool PageDefImpl::hasParentPage ( ) const

virtual

实现了 PageDef.

在文件 pagedef.cpp 第 143 行定义.

 {
   return getOuterScope() &&
          getOuterScope()->definitionType()==Definition::TypePage;
 }

引用了 Definition::definitionType(), DefinitionMixin< PageDef >::getOuterScope() , 以及 Definition::TypePage.

◆ hasSubPages()

bool PageDefImpl::hasSubPages ( ) const

virtual

实现了 PageDef.

在文件 pagedef.cpp 第 371 行定义.

 {
   return !m_subPages.empty();
 }

引用了 LinkedRefMap< T, Hash, KeyEqual, Map >::empty() , 以及 m_subPages.

被这些函数引用 writePageDocumentation().

◆ hasTitle()

bool PageDefImpl::hasTitle ( ) const

virtual

实现了 PageDef.

在文件 pagedef.cpp 第 396 行定义.

 {
   return !m_title.isEmpty() && m_title.lower()!="notitle";
 }

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

被这些函数引用 writeDocumentation().

◆ isLinkable()

virtual bool PageDefImpl::isLinkable ( ) const

inlinevirtual

Returns TRUE iff it is possible to link to this item. This can be a link to another project imported via a tag file.

实现了 PageDef.

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

55 { return m_localToc; }

引用了 m_localToc.

◆ isLinkableInProject()

virtual bool PageDefImpl::isLinkableInProject ( ) const

inlinevirtual

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

实现了 PageDef.

在文件 pagedef.cpp 第 54 行定义.

55 { return m_localToc; }

◆ localToc()

virtual LocalToc PageDefImpl::localToc ( ) const

inlinevirtual

实现了 PageDef.

在文件 pagedef.cpp 第 68 行定义.

77 {

◆ setFileName()

void PageDefImpl::setFileName ( const QCString & name )

virtual

实现了 PageDef.

在文件 pagedef.cpp 第 117 行定义.

 {
   m_fileName = name;
 }

引用了 m_fileName , 以及 DefinitionMixin< PageDef >::name().

◆ setLocalToc()

void PageDefImpl::setLocalToc ( const LocalToc & tl )

virtual

实现了 PageDef.

在文件 pagedef.cpp 第 381 行定义.

 {
   m_localToc = lt;
 }

引用了 m_localToc.

◆ setNestingLevel()

void PageDefImpl::setNestingLevel ( int l )

virtual

实现了 PageDef.

在文件 pagedef.cpp 第 376 行定义.

 {
   m_nestingLevel = l;
 }

引用了 m_nestingLevel.

◆ setPageScope()

virtual void PageDefImpl::setPageScope ( Definition * d )

inlinevirtual

实现了 PageDef.

在文件 pagedef.cpp 第 69 行定义.

77 {

◆ setShowLineNo()

void PageDefImpl::setShowLineNo ( bool b )

virtual

实现了 PageDef.

在文件 pagedef.cpp 第 386 行定义.

 {
   m_showLineNo = b;
 }

引用了 m_showLineNo.

◆ setTitle()

void PageDefImpl::setTitle ( const QCString & title )

virtual

实现了 PageDef.

在文件 pagedef.cpp 第 401 行定义.

 {
   m_title = title;
 }

引用了 m_title , 以及 title().

◆ showLineNo()

bool PageDefImpl::showLineNo ( ) const

virtual

实现了 PageDef.

在文件 pagedef.cpp 第 391 行定义.

 {
   return m_showLineNo;
 }

引用了 m_showLineNo.

◆ title()

virtual QCString PageDefImpl::title ( ) const

inlinevirtual

实现了 PageDef.

在文件 pagedef.cpp 第 59 行定义.

66 :

67 QCString m_fileName;

被这些函数引用 setTitle(), writeDocumentation(), writePageDocumentation() , 以及 writeTagFile().

◆ visibleInIndex()

bool PageDefImpl::visibleInIndex ( ) const

virtual

实现了 PageDef.

在文件 pagedef.cpp 第 353 行定义.

 {
   static bool externalPages = Config_getBool(EXTERNAL_PAGES);
   return // not part of a group
          !getGroupDef() &&
          // not an externally defined page
          (!isReference() || externalPages)
          ;
 }

引用了 Config_getBool, getGroupDef() , 以及 DefinitionMixin< PageDef >::isReference().

◆ writeDocumentation()

void PageDefImpl::writeDocumentation ( OutputList & ol )

virtual

实现了 PageDef.

在文件 pagedef.cpp 第 171 行定义.

 {
   static bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);
  
   //outputList->disable(OutputGenerator::Man);
   QCString pageName,manPageName;
   pageName    = escapeCharsInString(name(),FALSE,TRUE);
   manPageName = escapeCharsInString(name(),TRUE,TRUE);
  
   //printf("PageDefImpl::writeDocumentation: %s\n",getOutputFileBase().data());
  
   ol.pushGeneratorState();
   //1.{
  
   if (m_nestingLevel>0
       //&& // a sub page
       //(Doxygen::mainPage==0 || getOuterScope()!=Doxygen::mainPage) // and not a subpage of the mainpage
      )
   {
     // do not generate sub page output for RTF and LaTeX, as these are
     // part of their parent page
     ol.disableAll();
     ol.enable(OutputGenerator::Man);
     ol.enable(OutputGenerator::Html);
   }
  
   ol.pushGeneratorState();
   //2.{
   ol.disableAllBut(OutputGenerator::Man);
   startFile(ol,getOutputFileBase(),manPageName,title(),HLI_Pages,!generateTreeView);
   ol.enableAll();
   ol.disable(OutputGenerator::Man);
   startFile(ol,getOutputFileBase(),pageName,title(),HLI_Pages,!generateTreeView);
   ol.popGeneratorState();
   //2.}
  
   if (!generateTreeView)
   {
     if (getOuterScope()!=Doxygen::globalScope && !Config_getBool(DISABLE_INDEX))
     {
       DefinitionMutable *outerScope = toDefinitionMutable(getOuterScope());
       if (outerScope)
       {
         outerScope->writeNavigationPath(ol);
       }
     }
     ol.endQuickIndices();
   }
   const SectionInfo *si=SectionManager::instance().find(name());
  
   // save old generator state and write title only to Man generator
   ol.pushGeneratorState();
   //2.{
   ol.disableAllBut(OutputGenerator::Man);
   ol.startTitleHead(manPageName);
   ol.endTitleHead(manPageName, manPageName);
   if (si)
   {
     ol.pushGeneratorState();
     ol.disableAllBut(OutputGenerator::Man);
     ol.writeString(" - ");
     ol.popGeneratorState();
  
     if (si->title() != manPageName)
     {
       ol.generateDoc(docFile(),getStartBodyLine(),this,0,si->title(),TRUE,FALSE,
                      QCString(),TRUE,FALSE,Config_getBool(MARKDOWN_SUPPORT));
       ol.endSection(si->label(),si->type());
     }
   }
   ol.popGeneratorState();
   //2.}
  
   // for Latex the section is already generated as a chapter in the index!
   ol.pushGeneratorState();
   //2.{
   ol.disable(OutputGenerator::Latex);
   ol.disable(OutputGenerator::Docbook);
   ol.disable(OutputGenerator::RTF);
   ol.disable(OutputGenerator::Man);
   if (hasTitle() && !name().isEmpty() && si!=0)
   {
     ol.startPageDoc(si->title());
     //ol.startSection(si->label,si->title,si->type);
     startTitle(ol,getOutputFileBase(),this);
     ol.generateDoc(docFile(),getStartBodyLine(),this,0,si->title(),TRUE,FALSE,
                    QCString(),TRUE,FALSE,Config_getBool(MARKDOWN_SUPPORT));
     //stringToSearchIndex(getOutputFileBase(),
     //                    theTranslator->trPage(TRUE,TRUE)+" "+si->title,
     //                    si->title);
     //ol.endSection(si->label,si->type);
     endTitle(ol,getOutputFileBase(),name());
   }
   else
     ol.startPageDoc("");
   ol.startContents();
   ol.popGeneratorState();
   //2.}
  
   if ((m_localToc.isHtmlEnabled() || m_localToc.isLatexEnabled() || m_localToc.isDocbookEnabled()) && hasSections())
   {
     writeToc(ol, m_localToc);
   }
  
   writePageDocumentation(ol);
   ol.endContents();
   ol.endPageDoc();
  
   if (generateTreeView && getOuterScope()!=Doxygen::globalScope && !Config_getBool(DISABLE_INDEX))
   {
     endFileWithNavPath(getOuterScope(),ol);
   }
   else
   {
     endFile(ol,FALSE,TRUE);
   }
  
   ol.popGeneratorState();
   //1.}
 }

引用了 Config_getBool, OutputList::disable(), OutputList::disableAll(), OutputList::disableAllBut(), OutputGenerator::Docbook, DefinitionMixin< PageDef >::docFile(), OutputList::enable(), OutputList::enableAll(), OutputList::endContents(), endFile(), endFileWithNavPath(), OutputList::endPageDoc(), OutputList::endQuickIndices(), OutputList::endSection(), endTitle(), OutputList::endTitleHead(), escapeCharsInString(), FALSE, LinkedMap< T, Hash, KeyEqual, Map >::find(), OutputList::generateDoc(), DefinitionMixin< PageDef >::getOuterScope(), getOutputFileBase(), DefinitionMixin< PageDef >::getStartBodyLine(), Doxygen::globalScope, DefinitionMixin< PageDef >::hasSections(), hasTitle(), HLI_Pages, OutputGenerator::Html, SectionManager::instance(), LocalToc::isDocbookEnabled(), LocalToc::isHtmlEnabled(), LocalToc::isLatexEnabled(), SectionInfo::label(), OutputGenerator::Latex, m_localToc, m_nestingLevel, OutputGenerator::Man, DefinitionMixin< PageDef >::name(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), OutputGenerator::RTF, OutputList::startContents(), startFile(), OutputList::startPageDoc(), startTitle(), OutputList::startTitleHead(), title(), SectionInfo::title(), Definition::toDefinitionMutable, TRUE, SectionInfo::type(), DefinitionMutable::writeNavigationPath(), writePageDocumentation(), OutputList::writeString() , 以及 DefinitionMixin< PageDef >::writeToc().

◆ writePageDocumentation()

void PageDefImpl::writePageDocumentation ( OutputList & ol ) const

virtual

实现了 PageDef.

在文件 pagedef.cpp 第 292 行定义.

 {
   ol.startTextBlock();
   QCString docStr = documentation()+inbodyDocumentation();
   if (hasBriefDescription() && !SectionManager::instance().find(name()))
   {
     ol.pushGeneratorState();
     ol.disableAllBut(OutputGenerator::Man);
     ol.writeString(" - ");
     ol.popGeneratorState();
   }
   ol.generateDoc(
       docFile(),           // fileName
       docLine(),           // startLine
       this,                // context
       0,                   // memberdef
       docStr,              // docStr
       TRUE,                // index words
       FALSE,               // not an example
       QCString(),                   // exampleName
       FALSE,               // singleLine
       FALSE,               // linkFromIndex
       TRUE                 // markdown support
       );
   ol.endTextBlock();
  
   if (hasSubPages())
   {
     // for printed documentation we write subpages as section's of the
     // parent page.
     ol.pushGeneratorState();
     ol.disableAll();
     ol.enable(OutputGenerator::Latex);
     ol.enable(OutputGenerator::Docbook);
     ol.enable(OutputGenerator::RTF);
  
     for (const auto &subPage : m_subPages)
     {
       SectionType sectionType = SectionType::Paragraph;
       switch (m_nestingLevel)
       {
         case  0: sectionType = SectionType::Page;          break;
         case  1: sectionType = SectionType::Section;       break;
         case  2: sectionType = SectionType::Subsection;    break;
         case  3: sectionType = SectionType::Subsubsection; break;
         default: sectionType = SectionType::Paragraph;     break;
       }
       QCString title = subPage->title();
       if (title.isEmpty()) title = subPage->name();
       ol.startSection(subPage->name(),title,sectionType);
       ol.parseText(title);
       ol.endSection(subPage->name(),sectionType);
       Doxygen::subpageNestingLevel++;
       subPage->writePageDocumentation(ol);
       Doxygen::subpageNestingLevel--;
     }
  
     ol.popGeneratorState();
   }
 }

引用了 OutputList::disableAll(), OutputList::disableAllBut(), OutputGenerator::Docbook, DefinitionMixin< PageDef >::docFile(), DefinitionMixin< PageDef >::docLine(), DefinitionMixin< PageDef >::documentation(), OutputList::enable(), OutputList::endSection(), OutputList::endTextBlock(), FALSE, OutputList::generateDoc(), DefinitionMixin< PageDef >::hasBriefDescription(), hasSubPages(), DefinitionMixin< PageDef >::inbodyDocumentation(), SectionManager::instance(), QCString::isEmpty(), OutputGenerator::Latex, m_nestingLevel, m_subPages, OutputGenerator::Man, DefinitionMixin< PageDef >::name(), Page, Paragraph, OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), OutputGenerator::RTF, Section, OutputList::startSection(), OutputList::startTextBlock(), Doxygen::subpageNestingLevel, Subsection, Subsubsection, title(), TRUE , 以及 OutputList::writeString().

被这些函数引用 writeDocumentation().

◆ writeTagFile()

void PageDefImpl::writeTagFile ( TextStream & tagFile )

virtual

实现了 PageDef.

在文件 pagedef.cpp 第 149 行定义.

 {
   bool found = name()=="citelist";
   for (RefListManager::Ptr &rl : RefListManager::instance())
   {
     if (rl->listName()==name())
     {
       found=TRUE;
       break;
     }
   }
   if (!found) // not one of the generated related pages
   {
     tagFile << "  <compound kind=\"page\">\n";
     tagFile << "    <name>" << name() << "</name>\n";
     tagFile << "    <title>" << convertToXML(title()) << "</title>\n";
     tagFile << "    <filename>" << addHtmlExtensionIfMissing(getOutputFileBase()) << "</filename>\n";
     writeDocAnchorsToTagFile(tagFile);
     tagFile << "  </compound>\n";
   }
 }

引用了 addHtmlExtensionIfMissing(), convertToXML(), getOutputFileBase(), RefListManager::instance(), DefinitionMixin< PageDef >::name(), title(), TRUE , 以及 DefinitionMixin< PageDef >::writeDocAnchorsToTagFile().

类成员变量说明

◆ m_fileName

QCString PageDefImpl::m_fileName

private

在文件 pagedef.cpp 第 80 行定义.

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

◆ m_localToc

LocalToc PageDefImpl::m_localToc

private

在文件 pagedef.cpp 第 85 行定义.

被这些函数引用 isLinkable(), setLocalToc() , 以及 writeDocumentation().

◆ m_nestingLevel

int PageDefImpl::m_nestingLevel

private

在文件 pagedef.cpp 第 84 行定义.

被这些函数引用 addInnerCompound(), setNestingLevel(), writeDocumentation() , 以及 writePageDocumentation().

◆ m_pageScope

Definition* PageDefImpl::m_pageScope

private

在文件 pagedef.cpp 第 83 行定义.

被这些函数引用 anchor().

◆ m_showLineNo

bool PageDefImpl::m_showLineNo

private

在文件 pagedef.cpp 第 86 行定义.

被这些函数引用 setShowLineNo() , 以及 showLineNo().

◆ m_subPages

PageLinkedRefMap PageDefImpl::m_subPages

private

在文件 pagedef.cpp 第 82 行定义.

被这些函数引用 addInnerCompound(), hasSubPages() , 以及 writePageDocumentation().

◆ m_title

QCString PageDefImpl::m_title

private

在文件 pagedef.cpp 第 81 行定义.

被这些函数引用 hasTitle() , 以及 setTitle().

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

src/pagedef.cpp

Public 成员函数

Private 属性

额外继承的成员函数

详细描述

构造及析构函数说明

◆ PageDefImpl()

◆ ~PageDefImpl()

成员函数说明

◆ addInnerCompound()

◆ anchor()

◆ codeSymbolType()

◆ definitionType()

◆ displayName()

◆ documentedPage()

◆ findSectionsInDocumentation()

◆ getGroupDef()

◆ getOutputFileBase()

◆ getPageScope()

◆ getSubPages()

◆ hasParentPage()

◆ hasSubPages()

◆ hasTitle()

◆ isLinkable()

◆ isLinkableInProject()

◆ localToc()

◆ setFileName()

◆ setLocalToc()

◆ setNestingLevel()

◆ setPageScope()

◆ setShowLineNo()

◆ setTitle()

◆ showLineNo()

◆ title()

◆ visibleInIndex()

◆ writeDocumentation()

◆ writePageDocumentation()

◆ writeTagFile()

类成员变量说明

◆ m_fileName

◆ m_localToc

◆ m_nestingLevel

◆ m_pageScope

◆ m_showLineNo

◆ m_subPages

◆ m_title