Table of contents writer. More...

#include <tocwriter.h>

Collaboration diagram for TOCWriter:

Public Types
using	TitledNodeList = QList<std::pair<const Node*, QString>>

Public Member Functions
	TOCWriter (Generator *g, const QString &project)
	Constructs a new TOCWriter, using a Generator g to to fetch links (hrefs) for each TOC entry.
	TOCWriter (const TOCWriter &)=delete
TOCWriter &	operator= (const TOCWriter &)=delete
void	generateTOC (const QString &fileName, const QString &indexTitle)
	Writes the TOC entries for project to fileName, starting from a page with a title matching indexTitle.

Detailed Description

Table of contents writer.

Generates an XML file for the table of contents (TOC) for the documentation project. The TOC consists of (a nested) list of sub-pages documented with \toc command(s).

Definition at line 21 of file tocwriter.h.

Member Typedef Documentation

◆ TitledNodeList

using TOCWriter::TitledNodeList = QList<std::pair<const Node*, QString>>

Definition at line 24 of file tocwriter.h.

Constructor & Destructor Documentation

◆ TOCWriter() [1/2]

TOCWriter::TOCWriter	(	Generator *	g,
		const QString &	project )

Constructs a new TOCWriter, using a Generator g to to fetch links (hrefs) for each TOC entry.

A project name is used in error reporting.

Definition at line 33 of file tocwriter.cpp.

References QDocDatabase::qdocDB().

Here is the call graph for this function:

◆ TOCWriter() [2/2]

TOCWriter::TOCWriter ( const TOCWriter & )

delete

Member Function Documentation

◆ generateTOC()

void TOCWriter::generateTOC	(	const QString &	fileName,
		const QString &	indexTitle )

Writes the TOC entries for project to fileName, starting from a page with a title matching indexTitle.

Does nothing if indexTitle is an empty string.

Definition at line 46 of file tocwriter.cpp.

◆ operator=()

TOCWriter & TOCWriter::operator= ( const TOCWriter & )