class that provide information about a section. 更多...

#include <section.h>

SectionInfo 的协作图:

Public 成员函数
	SectionInfo (const QCString &label, const QCString &fileName, int lineNr, const QCString &title, SectionType type, int level, const QCString &ref)

	~SectionInfo ()

QCString	label () const

QCString	title () const

SectionType	type () const

QCString	ref () const

int	lineNr () const

QCString	fileName () const

bool	generated () const

int	level () const

Definition *	definition () const

void	setFileName (const QCString &fn)

void	setType (SectionType t)

void	setGenerated (bool b)

void	setDefinition (Definition *d)

void	setTitle (const QCString &t)

void	setLevel (int l)

void	setReference (const QCString &r)

void	setLineNr (int l)

Private 属性
QCString	m_label

QCString	m_title

SectionType	m_type

QCString	m_ref

int	m_lineNr

QCString	m_fileName

bool	m_generated = false

int	m_level

Definition *	m_definition = 0

详细描述

class that provide information about a section.

在文件 section.h 第 49 行定义.

构造及析构函数说明

◆ SectionInfo()

SectionInfo::SectionInfo	(	const QCString &	label,
		const QCString &	fileName,
		int	lineNr,
		const QCString &	title,
		SectionType	type,
		int	level,
		const QCString &	ref
	)

inline

在文件 section.h 第 52 行定义.

                                                                                         :
         m_label(label), m_title(title), m_type(type), m_ref(ref),
         m_lineNr(lineNr), m_fileName(fileName), m_level(level)
     {
       //printf("SectionInfo(%p)\n",this);
     }

◆ ~SectionInfo()

SectionInfo::~SectionInfo ( )

inline

在文件 section.h 第 59 行定义.

     {
       //printf("~SectionInfo(%p)\n",this);
     }

成员函数说明

◆ definition()

Definition* SectionInfo::definition ( ) const

inline

在文件 section.h 第 73 行定义.

73 { return m_definition; }

引用了 m_definition.

被这些函数引用 resolveLink().

◆ fileName()

QCString SectionInfo::fileName ( ) const

inline

在文件 section.h 第 70 行定义.

70 { return m_fileName; }

引用了 m_fileName.

被这些函数引用 SectionManager::add(), addRelatedPage(), DocAnchor::DocAnchor(), DocHtmlCaption::DocHtmlCaption(), DocRef::DocRef(), findMainPage(), DocSection::parse(), DocSecRefItem::parse() , 以及 DefinitionImpl::writeDocAnchorsToTagFile().

◆ generated()

bool SectionInfo::generated ( ) const

inline

在文件 section.h 第 71 行定义.

71 { return m_generated; }

引用了 m_generated.

被这些函数引用 DefinitionImpl::writeDocAnchorsToTagFile().

◆ label()

QCString SectionInfo::label ( ) const

inline

在文件 section.h 第 65 行定义.

65 { return m_label; }

引用了 m_label.

被这些函数引用 SectionRefs::add(), SectionManager::add(), DefinitionImpl::addSectionsToDefinition(), DefinitionImpl::addSectionsToIndex(), DocAnchor::DocAnchor(), DocHtmlCaption::DocHtmlCaption(), DocRef::DocRef(), DocSection::parse(), DocSecRefItem::parse(), resolveLink(), DefinitionImpl::writeDocAnchorsToTagFile(), PageDefImpl::writeDocumentation(), writeGroupTreeNode(), GroupDefImpl::writePageDocumentation() , 以及 DefinitionImpl::writeToc().

◆ level()

int SectionInfo::level ( ) const

inline

在文件 section.h 第 72 行定义.

72 { return m_level; }

引用了 m_level.

被这些函数引用 SectionManager::add().

◆ lineNr()

int SectionInfo::lineNr ( ) const

inline

在文件 section.h 第 69 行定义.

69 { return m_lineNr; }

引用了 m_lineNr.

被这些函数引用 SectionManager::add(), addRelatedPage() , 以及 findMainPage().

◆ ref()

QCString SectionInfo::ref ( ) const

inline

在文件 section.h 第 68 行定义.

68 { return m_ref; }

引用了 m_ref.

被这些函数引用 SectionManager::add(), addRelatedPage(), DocRef::DocRef(), findMainPage(), DocSecRefItem::parse() , 以及 DefinitionImpl::writeDocAnchorsToTagFile().

◆ setDefinition()

void SectionInfo::setDefinition ( Definition * d )

inline

在文件 section.h 第 79 行定义.

79 { m_definition = d; }

引用了 m_definition.

被这些函数引用 DefinitionImpl::addSectionsToDefinition().

◆ setFileName()

void SectionInfo::setFileName ( const QCString & fn )

inline

在文件 section.h 第 76 行定义.

76 { m_fileName = fn; }

引用了 m_fileName.

被这些函数引用 SectionManager::replace().

◆ setGenerated()

void SectionInfo::setGenerated ( bool b )

inline

在文件 section.h 第 78 行定义.

78 { m_generated = b; }

引用了 m_generated.

◆ setLevel()

void SectionInfo::setLevel ( int l )

inline

在文件 section.h 第 81 行定义.

81 { m_level = l; }

引用了 m_level.

被这些函数引用 SectionManager::replace().

◆ setLineNr()

void SectionInfo::setLineNr ( int l )

inline

在文件 section.h 第 83 行定义.

83 { m_lineNr = l; }

引用了 m_lineNr.

被这些函数引用 SectionManager::replace().

◆ setReference()

void SectionInfo::setReference ( const QCString & r )

inline

在文件 section.h 第 82 行定义.

82 { m_ref = r; }

引用了 m_ref.

被这些函数引用 SectionManager::replace().

◆ setTitle()

void SectionInfo::setTitle ( const QCString & t )

inline

在文件 section.h 第 80 行定义.

80 { m_title = t; }

引用了 m_title.

被这些函数引用 addRelatedPage() , 以及 SectionManager::replace().

◆ setType()

void SectionInfo::setType ( SectionType t )

inline

在文件 section.h 第 77 行定义.

77 { m_type = t; }

引用了 m_type.

被这些函数引用 SectionManager::replace().

◆ title()

QCString SectionInfo::title ( ) const

inline

在文件 section.h 第 66 行定义.

66 { return m_title; }

引用了 m_title.

被这些函数引用 SectionManager::add(), DefinitionImpl::addSectionsToIndex(), DocRef::DocRef(), PerlModGenerator::generatePerlModForPage(), generateXMLForPage(), DocSection::parse(), DefinitionImpl::writeDocAnchorsToTagFile(), PageDefImpl::writeDocumentation(), GroupDefImpl::writePageDocumentation() , 以及 DefinitionImpl::writeToc().

◆ type()

SectionType SectionInfo::type ( ) const

inline

在文件 section.h 第 67 行定义.

67 { return m_type; }

引用了 m_type.

被这些函数引用 SectionManager::add(), DefinitionImpl::addSectionsToIndex(), DocRef::DocRef(), DefinitionImpl::hasSections(), DocSecRefItem::parse(), PageDefImpl::writeDocumentation() , 以及 DefinitionImpl::writeToc().

类成员变量说明

◆ m_definition

Definition* SectionInfo::m_definition = 0

private

在文件 section.h 第 94 行定义.

被这些函数引用 definition() , 以及 setDefinition().

◆ m_fileName

QCString SectionInfo::m_fileName

private

在文件 section.h 第 91 行定义.

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

◆ m_generated

bool SectionInfo::m_generated = false

private

在文件 section.h 第 92 行定义.

被这些函数引用 generated() , 以及 setGenerated().

◆ m_label

QCString SectionInfo::m_label

private

在文件 section.h 第 86 行定义.

被这些函数引用 label().

◆ m_level

int SectionInfo::m_level

private

在文件 section.h 第 93 行定义.

被这些函数引用 level() , 以及 setLevel().

◆ m_lineNr

int SectionInfo::m_lineNr

private

在文件 section.h 第 90 行定义.

被这些函数引用 lineNr() , 以及 setLineNr().

◆ m_ref

QCString SectionInfo::m_ref

private

在文件 section.h 第 89 行定义.

被这些函数引用 ref() , 以及 setReference().

◆ m_title

QCString SectionInfo::m_title

private

在文件 section.h 第 87 行定义.

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

◆ m_type

SectionType SectionInfo::m_type

private

在文件 section.h 第 88 行定义.

被这些函数引用 setType() , 以及 type().

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

src/section.h

Public 成员函数

Private 属性

详细描述

构造及析构函数说明

◆ SectionInfo()

◆ ~SectionInfo()

成员函数说明

◆ definition()

◆ fileName()

◆ generated()

◆ label()

◆ level()

◆ lineNr()

◆ ref()

◆ setDefinition()

◆ setFileName()

◆ setGenerated()

◆ setLevel()

◆ setLineNr()

◆ setReference()

◆ setTitle()

◆ setType()

◆ title()

◆ type()

类成员变量说明

◆ m_definition

◆ m_fileName

◆ m_generated

◆ m_label

◆ m_level

◆ m_lineNr

◆ m_ref

◆ m_title

◆ m_type