utilities.h File Reference

(a7f422d98ecbf775a8963a5057a68d48bb5ac59f)

#include <QtCore/qstring.h>
#include <QtCore/qloggingcategory.h>
#include <functional>

Include dependency graph for utilities.h:

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

Go to the source code of this file.

Namespaces
namespace	Utilities
	This namespace holds QDoc-internal utility methods.

Enumerations
enum class	Utilities::ExampleFileKind { Utilities::File , Utilities::Image }

Functions
void	Utilities::startDebugging (const QString &message)
void	Utilities::stopDebugging (const QString &message)
bool	Utilities::debugging ()
const INode *	Utilities::nodeForString (const QString &string)
	Converts a string representation of a pointer address to an INode pointer.
QString	Utilities::stringForNode (const INode *node)
	Converts an INode pointer address to its string representation.
QString	Utilities::uniqueIdentifier (const Location &loc, const QString &prefix)
	Returns a unique identifier based on location loc, with a given prefix.
QString	Utilities::separator (qsizetype wordPosition, qsizetype numberOfWords)
QString	Utilities::comma (qsizetype wordPosition, qsizetype numberOfWords)
QString	Utilities::asAsciiPrintable (const QString &str)
	Returns an ascii-printable representation of str.
QString	Utilities::protect (const QString &string)
QStringList	Utilities::getInternalIncludePaths (const QString &compiler)
bool	Utilities::isGeneratedFile (const QString &path)
QStringList	Utilities::pathAndFragment (const QString &linkText)
	Returns a string list containing the path and fragment components of the given linkText.
QString	Utilities::linkForExampleFile (const QString &path, const QString &project, const QString &fileExt)
	Constructs an href link from an example file name.
QString	Utilities::exampleFileTitle (const QString &fileName, ExampleFileKind kind)
	Constructs a title for a file or image page in an example.
QString	Utilities::exampleFileTitle (const QStringList &files, const QStringList &images, const QString &fileName)
	Constructs a title for a file or image page in an example.
QString	Utilities::computeFileBase (const Node *node, const QString &project, const std::function< QString(const Node *)> &prefixFn, const std::function< QString(const Node *)> &suffixFn)

Variables
static constexpr QLatin1StringView	Utilities::samp = "&"_L1
static constexpr QLatin1StringView	Utilities::slt = "<"_L1
static constexpr QLatin1StringView	Utilities::sgt = ">"_L1
static constexpr QLatin1StringView	Utilities::squot = """_L1