SectionRefs类 参考

class that represents a list of constant references to sections. 更多...

#include <section.h>

Public 类型
using	const_iterator = SectionInfoVec::const_iterator

Public 成员函数
const SectionInfo *	find (const QCString &label) const
	Returns a constant pointer to the section info given a section label or nullptr if no section with the given label can be found. 更多...
void	add (const SectionInfo *si)
	Adds a non-owning section reference. 更多...
const_iterator	begin () const
const_iterator	end () const
bool	empty () const
size_t	size () const

Private 类型
using	SectionInfoVec = std::vector< const SectionInfo * >

Private 属性
SectionInfoVec	m_entries
std::unordered_map< std::string, const SectionInfo * >	m_lookup

详细描述

class that represents a list of constant references to sections.

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

成员类型定义说明

const_iterator

using SectionRefs::const_iterator = SectionInfoVec::const_iterator

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

SectionInfoVec

using SectionRefs::SectionInfoVec = std::vector<const SectionInfo*>

private

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

成员函数说明

add()

void SectionRefs::add ( const SectionInfo *  si )

inline

Adds a non-owning section reference.

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

    {
      m_lookup.insert({toStdString(si->label()),si});
      m_entries.push_back(si);
    }

引用了 SectionInfo::label(), m_entries, m_lookup , 以及 toStdString().

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

begin()

const_iterator SectionRefs::begin ( ) const

inline

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

{ return m_entries.cbegin(); }

引用了 m_entries.

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

empty()

bool SectionRefs::empty ( ) const

inline

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

{ return m_entries.empty(); }

引用了 m_entries.

被这些函数引用 DefinitionImpl::addSectionsToIndex(), generateXMLForPage(), DefinitionImpl::hasSections(), DefinitionImpl::writeDocAnchorsToTagFile() , 以及 DefinitionImpl::writeToc().

end()

const_iterator SectionRefs::end ( ) const

inline

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

{ return m_entries.cend(); }

引用了 m_entries.

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

find()

const SectionInfo* SectionRefs::find ( const QCString &  label ) const

inline

Returns a constant pointer to the section info given a section label or nullptr if no section with the given label can be found.

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

    {
      auto it = m_lookup.find(label.str());
      return it!=m_lookup.end() ? it->second : nullptr;
    }

引用了 m_lookup , 以及 QCString::str().

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

size()

size_t SectionRefs::size ( ) const

inline

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

{ return m_entries.size(); }

引用了 m_entries.

类成员变量说明

m_entries

SectionInfoVec SectionRefs::m_entries

private

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

被这些函数引用 add(), begin(), empty(), end() , 以及 size().

m_lookup

std::unordered_map< std::string, const SectionInfo* > SectionRefs::m_lookup

private

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

被这些函数引用 add() , 以及 find().

---

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

• src/section.h