generator.h File Reference

(77a13c15833f21a09ed4a367835ccaf1f1d07627)

#include "text.h"
#include "utilities.h"
#include "filesystem/fileresolver.h"
#include <QtCore/qlist.h>
#include <QtCore/qmap.h>
#include <QtCore/qstring.h>
#include <QtCore/qstringlist.h>
#include <QtCore/qtextstream.h>
#include <optional>

Include dependency graph for generator.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	Generator

Functions
std::optional< QString >	formatStatus (const Node *node, QDocDatabase *qdb)

Variables
QT_BEGIN_NAMESPACE typedef QMultiMap< QString, Node * >	NodeMultiMap

Function Documentation

formatStatus()

std::optional< QString > formatStatus	(	const Node *	node,
		QDocDatabase *	qdb )

Returns a string representing status information of a node.

If a status description is returned, it is one of: \list

• Custom status set explicitly in node's documentation using {\meta {status} {}},
• 'Deprecated [since <version>]' (\deprecated [<version>]),
• 'Until <version>',
• 'Preliminary' (\preliminary), or
• The description adopted from associated module's state: {\modulestate {}}. \endlist

Otherwise, returns std::nullopt.

Definition at line 1138 of file generator.cpp.

References Node< _Tp >::Deprecated, Node< _Tp >::doc(), QDocDatabase::getModuleNode(), Doc::metaTagMap(), Node< _Tp >::Preliminary, and Node< _Tp >::status().

Here is the call graph for this function:

Variable Documentation

NodeMultiMap

QT_BEGIN_NAMESPACE typedef QMultiMap<QString, Node *> NodeMultiMap

Definition at line 20 of file generator.h.

Referenced by DocBookGenerator::generateAtom(), HtmlGenerator::generateAtom(), and QDocDatabase::resolveNamespaces().