class that provide information about a section. More...

#include <src/section.h>

Collaboration diagram for SectionInfo:

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

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 Attributes
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 = nullptr

Detailed Description

class that provide information about a section.

Definition at line 56 of file section.h.

Constructor & Destructor Documentation

◆ SectionInfo()

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

inline

Definition at line 59 of file section.h.

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

References fileName(), label(), level(), lineNr(), m_fileName, m_label, m_level, m_lineNr, m_ref, m_title, m_type, ref(), title(), and type().

Member Function Documentation

◆ definition()

Definition * SectionInfo::definition ( ) const

inline

Definition at line 76 of file section.h.

76{ return m_definition; }

SectionInfo::m_definition

Definition * m_definition

Definition section.h:97

References m_definition.

Referenced by resolveLink().

◆ fileName()

QCString SectionInfo::fileName ( ) const

inline

Definition at line 73 of file section.h.

73{ return m_fileName; }

References m_fileName.

Referenced by SectionManager::add(), addAnchor(), addRelatedPage(), addSection(), PageDefImpl::addSectionsToIndex(), addXRefItem(), DocAnchor::DocAnchor(), DocHtmlCaption::DocHtmlCaption(), DocRef::DocRef(), findMainPage(), DocSecRefItem::parse(), DocSection::parse(), SectionInfo(), DefinitionImpl::writeDocAnchorsToTagFile(), and writeJavasScriptSearchDataPage().

◆ generated()

bool SectionInfo::generated ( ) const

inline

Definition at line 74 of file section.h.

74{ return m_generated; }

SectionInfo::m_generated

bool m_generated

Definition section.h:95

References m_generated.

Referenced by DefinitionImpl::writeDocAnchorsToTagFile().

◆ label()

QCString SectionInfo::label ( ) const

inline

Definition at line 68 of file section.h.

68{ return m_label; }

References m_label.

Referenced by SectionManager::add(), SectionRefs::add(), DefinitionImpl::addSectionsToDefinition(), PageDefImpl::addSectionsToIndex(), DocAnchor::DocAnchor(), DocHtmlCaption::DocHtmlCaption(), DocRef::DocRef(), DocSecRefItem::parse(), DocSection::parse(), resolveLink(), SectionInfo(), DefinitionImpl::writeDocAnchorsToTagFile(), PageDefImpl::writeDocumentation(), writeGroupTreeNode(), writeJavasScriptSearchDataPage(), and GroupDefImpl::writePageDocumentation().

◆ level()

int SectionInfo::level ( ) const

inline

Definition at line 75 of file section.h.

75{ return m_level; }

References m_level.

Referenced by SectionManager::add(), and SectionInfo().

◆ lineNr()

int SectionInfo::lineNr ( ) const

inline

Definition at line 72 of file section.h.

72{ return m_lineNr; }

References m_lineNr.

Referenced by SectionManager::add(), addAnchor(), addRelatedPage(), addSection(), PageDefImpl::addSectionsToIndex(), addXRefItem(), findMainPage(), and SectionInfo().

◆ ref()

QCString SectionInfo::ref ( ) const

inline

Definition at line 71 of file section.h.

71{ return m_ref; }

References m_ref.

Referenced by SectionManager::add(), addAnchor(), addRelatedPage(), addSection(), addXRefItem(), DocRef::DocRef(), findMainPage(), DocSecRefItem::parse(), SectionInfo(), DefinitionImpl::writeDocAnchorsToTagFile(), and writeJavasScriptSearchDataPage().

◆ setDefinition()

void SectionInfo::setDefinition ( Definition * d )

inline

Definition at line 82 of file section.h.

82{ m_definition = d; }

References m_definition.

Referenced by DefinitionImpl::addSectionsToDefinition().

◆ setFileName()

void SectionInfo::setFileName ( const QCString & fn )

inline

Definition at line 79 of file section.h.

79{ m_fileName = fn; }

References m_fileName.

Referenced by processSection(), and SectionManager::replace().

◆ setGenerated()

void SectionInfo::setGenerated ( bool b )

inline

Definition at line 81 of file section.h.

81{ m_generated = b; }

References m_generated.

◆ setLevel()

void SectionInfo::setLevel ( int l )

inline

Definition at line 84 of file section.h.

84{ m_level = l; }

References m_level.

Referenced by SectionManager::replace().

◆ setLineNr()

void SectionInfo::setLineNr ( int l )

inline

Definition at line 86 of file section.h.

86{ m_lineNr = l; }

References m_lineNr.

Referenced by SectionManager::replace().

◆ setReference()

void SectionInfo::setReference ( const QCString & r )

inline

Definition at line 85 of file section.h.

85{ m_ref = r; }

References m_ref.

Referenced by SectionManager::replace().

◆ setTitle()

void SectionInfo::setTitle ( const QCString & t )

inline

Definition at line 83 of file section.h.

83{ m_title = t; }

References m_title.

Referenced by addRelatedPage(), and SectionManager::replace().

◆ setType()

void SectionInfo::setType ( SectionType t )

inline

Definition at line 80 of file section.h.

80{ m_type = t; }

References m_type.

Referenced by processSection(), and SectionManager::replace().

◆ title()

QCString SectionInfo::title ( ) const

inline

Definition at line 69 of file section.h.

69{ return m_title; }

References m_title.

Referenced by SectionManager::add(), PageDefImpl::addSectionsToIndex(), DocRef::DocRef(), PerlModGenerator::generatePerlModForPage(), generateSqlite3ForPage(), generateXMLForPage(), DocSection::parse(), SectionInfo(), DefinitionImpl::writeDocAnchorsToTagFile(), PageDefImpl::writeDocumentation(), writeJavasScriptSearchDataPage(), and GroupDefImpl::writePageDocumentation().

◆ type()

SectionType SectionInfo::type ( ) const

inline

Definition at line 70 of file section.h.

70{ return m_type; }

References m_type.

Referenced by SectionManager::add(), PageDefImpl::addSectionsToIndex(), DocRef::DocRef(), DefinitionImpl::hasSections(), DocSecRefItem::parse(), SectionInfo(), and PageDefImpl::writeDocumentation().

Member Data Documentation

◆ m_definition

Definition* SectionInfo::m_definition = nullptr

private

Definition at line 97 of file section.h.

Referenced by definition(), and setDefinition().

◆ m_fileName

QCString SectionInfo::m_fileName

private

Definition at line 94 of file section.h.

Referenced by fileName(), SectionInfo(), and setFileName().

◆ m_generated

bool SectionInfo::m_generated = false

private

Definition at line 95 of file section.h.

Referenced by generated(), and setGenerated().

◆ m_label

QCString SectionInfo::m_label

private

Definition at line 89 of file section.h.

Referenced by label(), and SectionInfo().

◆ m_level

int SectionInfo::m_level

private

Definition at line 96 of file section.h.

Referenced by level(), SectionInfo(), and setLevel().

◆ m_lineNr

int SectionInfo::m_lineNr

private

Definition at line 93 of file section.h.

Referenced by lineNr(), SectionInfo(), and setLineNr().

◆ m_ref

QCString SectionInfo::m_ref

private

Definition at line 92 of file section.h.

Referenced by ref(), SectionInfo(), and setReference().

◆ m_title

QCString SectionInfo::m_title

private

Definition at line 90 of file section.h.

Referenced by SectionInfo(), setTitle(), and title().

◆ m_type

SectionType SectionInfo::m_type

private

Definition at line 91 of file section.h.

Referenced by SectionInfo(), setType(), and type().

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

src/section.h

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SectionInfo()

Member Function Documentation

◆ definition()

◆ fileName()

◆ generated()

◆ label()

◆ level()

◆ lineNr()

◆ ref()

◆ setDefinition()

◆ setFileName()

◆ setGenerated()

◆ setLevel()

◆ setLineNr()

◆ setReference()

◆ setTitle()

◆ setType()

◆ title()

◆ type()

Member Data Documentation

◆ m_definition

◆ m_fileName

◆ m_generated

◆ m_label

◆ m_level

◆ m_lineNr

◆ m_ref

◆ m_title

◆ m_type