ManifestWriter Class Reference

The ManifestWriter is responsible for writing manifest files. More...

#include <manifestwriter.h>

Collaboration diagram for ManifestWriter:

Public Member Functions
	ManifestWriter ()
void	generateManifestFiles ()
	This function outputs one or more manifest files in XML.
void	generateExampleManifestFile ()
	This function is called by generateExampleManifestFiles(), once for each manifest file to be generated.
void	readManifestMetaContent ()
	Reads metacontent - additional attributes and tags to apply when generating manifest files, read from config.
QString	retrieveExampleInstallationPath (const ExampleNode *example) const
	Retrieve the install path for the example as specified with the \meta command, or fall back to the one defined in .qdocconf.

Detailed Description

The ManifestWriter is responsible for writing manifest files.

Definition at line 15 of file manifestwriter.h.

Constructor & Destructor Documentation

ManifestWriter()

ManifestWriter::ManifestWriter

(

)

Definition at line 153 of file manifestwriter.cpp.

References QDocDatabase::qdocDB(), and readManifestMetaContent().

Referenced by HtmlGenerator::initializeGenerator().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

generateExampleManifestFile()

void ManifestWriter::generateExampleManifestFile

(

)

This function is called by generateExampleManifestFiles(), once for each manifest file to be generated.

Definition at line 269 of file manifestwriter.cpp.

References QDocDatabase::exampleNodeMap().

Referenced by generateManifestFiles().

Here is the call graph for this function:

Here is the caller graph for this function:

generateManifestFiles()

void ManifestWriter::generateManifestFiles

(

)

This function outputs one or more manifest files in XML.

They are used by Creator.

Definition at line 200 of file manifestwriter.cpp.

References QDocDatabase::exampleNodeMap(), and generateExampleManifestFile().

Referenced by HtmlGenerator::generateDocs().

Here is the call graph for this function:

Here is the caller graph for this function:

readManifestMetaContent()

void ManifestWriter::readManifestMetaContent

(

)

Reads metacontent - additional attributes and tags to apply when generating manifest files, read from config.

The manifest metacontent map is cleared immediately after the manifest files have been generated.

Definition at line 376 of file manifestwriter.cpp.

Referenced by ManifestWriter().

Here is the caller graph for this function:

retrieveExampleInstallationPath()

QString ManifestWriter::retrieveExampleInstallationPath

(

const ExampleNode *

example

)

const

Retrieve the install path for the example as specified with the \meta command, or fall back to the one defined in .qdocconf.

Definition at line 400 of file manifestwriter.cpp.

References Node< _Tp >::doc().

Here is the call graph for this function:

---

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

• qttools/src/qdoc/qdoc/src/qdoc/manifestwriter.h (5212645b4665917019a96ba873d9e98c1a136b5f)
• qttools/src/qdoc/qdoc/src/qdoc/manifestwriter.cpp (4d59b4ca8137180a01e85fbfb49e9afe6266f7da)