SectionType Class Reference

#include <src/section.h>

Public Member Functions
constexpr	SectionType ()
constexpr	SectionType (int lvl)
constexpr int	level () const
constexpr bool	isSection () const

Static Public Attributes
static constexpr int	Page = 0
static constexpr int	MinLevel = 1
static constexpr int	Section = 1
static constexpr int	Subsection = 2
static constexpr int	Subsubsection = 3
static constexpr int	Paragraph = 4
static constexpr int	Subparagraph = 5
static constexpr int	Subsubparagraph = 6
static constexpr int	MaxLevel = 6
static constexpr int	Anchor = 7
static constexpr int	Table = 8

Private Attributes
int	m_level

Detailed Description

Definition at line 28 of file section.h.

Constructor & Destructor Documentation

SectionType() [1/2]

SectionType::SectionType ( )

inlineconstexpr

Definition at line 43 of file section.h.

: m_level(0) {}

References m_level.

SectionType() [2/2]

SectionType::SectionType ( int lvl )

inlineconstexpr

Definition at line 44 of file section.h.

: m_level(lvl) {}

References m_level.

Member Function Documentation

isSection()

bool SectionType::isSection ( ) const

inlineconstexpr

Definition at line 46 of file section.h.

    {
      return m_level>=SectionType::MinLevel && m_level<=SectionType::MaxLevel;
    }

References m_level, MaxLevel, and MinLevel.

Referenced by PageDefImpl::addSectionsToIndex(), and DefinitionImpl::hasSections().

level()

int SectionType::level ( ) const

inlineconstexpr

Definition at line 45 of file section.h.

{ return m_level; }

References m_level.

Referenced by PageDefImpl::addSectionsToIndex(), DocRef::DocRef(), LatexDocVisitor::endLink(), and DocSecRefItem::parse().

Member Data Documentation

Anchor

int SectionType::Anchor = 7

staticconstexpr

Definition at line 40 of file section.h.

Referenced by addAnchor(), anonymous_namespace{tagreader.cpp}::TagFileParser::addDocAnchors(), addXRefItem(), anonymous_namespace{tagreader.cpp}::TagFileParser::buildLists(), DocRef::DocRef(), DocSecRefItem::parse(), and sectionLevelToType().

m_level

int SectionType::m_level

private

Definition at line 52 of file section.h.

Referenced by isSection(), level(), SectionType(), and SectionType().

MaxLevel

int SectionType::MaxLevel = 6

staticconstexpr

Definition at line 39 of file section.h.

Referenced by handleSection(), handleToc(), Markdown::Private::isAtxHeader(), isSection(), RTFDocVisitor::operator()(), parseIncludeOptions(), Markdown::Private::processLink(), sectionLevelToType(), and RTFGenerator::startSection().

MinLevel

int SectionType::MinLevel = 1

staticconstexpr

Definition at line 32 of file section.h.

Referenced by isSection(), RTFDocVisitor::operator()(), Markdown::Private::processLink(), and RTFGenerator::startSection().

Page

int SectionType::Page = 0

staticconstexpr

Definition at line 31 of file section.h.

Referenced by addRelatedPage(), DocRef::DocRef(), HtmlGenerator::endSection(), ManGenerator::endSection(), findMainPage(), DocSecRefItem::parse(), HtmlGenerator::startSection(), LatexGenerator::startSection(), ManGenerator::startSection(), and RTFGenerator::startSection().

Paragraph

int SectionType::Paragraph = 4

staticconstexpr

Definition at line 36 of file section.h.

Referenced by HtmlGenerator::endSection(), ManGenerator::endSection(), handleSection(), HtmlGenerator::startSection(), LatexGenerator::startSection(), ManGenerator::startSection(), RTFGenerator::startSection(), and Markdown::Private::writeOneLineHeaderOrRuler().

Section

int SectionType::Section = 1

staticconstexpr

Definition at line 33 of file section.h.

Referenced by HtmlGenerator::endSection(), ManGenerator::endSection(), handleSection(), HtmlGenerator::startSection(), LatexGenerator::startSection(), ManGenerator::startSection(), RTFGenerator::startSection(), and Markdown::Private::writeOneLineHeaderOrRuler().

Subparagraph

int SectionType::Subparagraph = 5

staticconstexpr

Definition at line 37 of file section.h.

Referenced by HtmlGenerator::endSection(), ManGenerator::endSection(), handleSection(), HtmlGenerator::startSection(), LatexGenerator::startSection(), ManGenerator::startSection(), RTFGenerator::startSection(), and Markdown::Private::writeOneLineHeaderOrRuler().

Subsection

int SectionType::Subsection = 2

staticconstexpr

Definition at line 34 of file section.h.

Referenced by HtmlGenerator::endSection(), ManGenerator::endSection(), handleSection(), HtmlGenerator::startSection(), LatexGenerator::startSection(), ManGenerator::startSection(), RTFGenerator::startSection(), writeMemberList(), Markdown::Private::writeOneLineHeaderOrRuler(), and GroupDefImpl::writePageDocumentation().

Subsubparagraph

int SectionType::Subsubparagraph = 6

staticconstexpr

Definition at line 38 of file section.h.

Referenced by HtmlGenerator::endSection(), ManGenerator::endSection(), handleSection(), HtmlGenerator::startSection(), LatexGenerator::startSection(), ManGenerator::startSection(), RTFGenerator::startSection(), and Markdown::Private::writeOneLineHeaderOrRuler().

Subsubsection

int SectionType::Subsubsection = 3

staticconstexpr

Definition at line 35 of file section.h.

Referenced by HtmlGenerator::endSection(), ManGenerator::endSection(), handleSection(), HtmlGenerator::startSection(), LatexGenerator::startSection(), ManGenerator::startSection(), RTFGenerator::startSection(), and Markdown::Private::writeOneLineHeaderOrRuler().

Table

int SectionType::Table = 8

staticconstexpr

Definition at line 41 of file section.h.

Referenced by DocRef::DocRef(), and DocSecRefItem::parse().

---

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

• src/section.h