The Config class contains the configuration variables for controlling how qdoc produces documentation. More...

#include <config.h>

Inheritance diagram for Config:

Collaboration diagram for Config:

Classes
struct	ExcludedPaths
struct	InternalFilePatterns
struct	SourceLink
struct	HeaderFilePath

Public Types
enum	QDocPass { Neither , Prepare , Generate }
enum	PathFlags : unsigned char { None = 0x0 , Validate = 0x1 , IncludePaths = 0x2 }
	Flags used for retrieving canonicalized paths from Config. More...

Public Member Functions
	~Config ()
void	init (const QString &programName, const QStringList &args)
	Initializes the Config with programName and sets all internal state variables to either default values or to ones defined in command line arguments args.
bool	getDebug () const
bool	getAtomsDump () const
bool	showInternal () const
bool	showAutoGeneratedDocs () const
bool	includePrivate () const
bool	includePrivateFunction () const
bool	includePrivateType () const
bool	includePrivateVariable () const
void	clear ()
	Clears the location and internal maps for config variables.
void	reset ()
	Resets the Config instance and loads the default values.
void	load (const QString &fileName)
	Loads and parses the qdoc configuration file fileName.
void	setStringList (const QString &var, const QStringList &valuesvalues)
	Sets the values of a configuration variable var from a string list.
void	insertStringList (const QString &var, const QStringList &valuesvalues)
	Adds the values from a string list to the configuration variable var.
void	showHelp (int exitCode=0)
QStringList	qdocFiles () const
const QString &	programName () const
const Location &	location () const
const ConfigVar &	get (const QString &var) const
QString	getOutputDir (const QString &formatformat=QString("HTML")) const
	Function to return the correct outputdir for the output format.
bool	contains (const QString &var) const
QStringList	variableNames () const
QSet< QString >	getOutputFormats () const
	Function to return the correct outputformats.
QStringList	getCanonicalPathList (const QString &var, PathFlags flagsflags=None) const
	Returns a path list where all paths from the config variable var are canonicalized.
QRegularExpression	getRegExp (const QString &var) const
	Calls getRegExpList() with the control variable var and iterates through the resulting list of regular expressions, concatenating them with extra characters to form a single QRegularExpression, which is then returned.
QList< QRegularExpression >	getRegExpList (const QString &var) const
	Looks up the configuration variable var in the string list map, converts the string list to a list of regular expressions, and returns it.
QSet< QString >	subVars (const QString &var) const
	This function is slower than it could be.
QStringList	getAllFiles (const QString &filesVar, const QString &dirsVar, const QSet< QString > &excludedDirs=QSet< QString >(), const QSet< QString > &excludedFiles=QSet< QString >())
	Builds and returns a list of file pathnames for the file type specified by filesVar (e.g.
QString	getIncludeFilePath (const QString &fileName) const
	Searches for a path to fileName in 'sources', 'sourcedirs', and 'exampledirs' config variables and returns a full path to the first match found.
QStringList	getExampleQdocFiles (const QSet< QString > &excludedDirs, const QSet< QString > &excludedFiles)
QStringList	getExampleImageFiles (const QSet< QString > &excludedDirs, const QSet< QString > &excludedFiles)
QString	getExampleProjectFile (const QString &examplePath)
	Returns the path to the project file for examplePath, or an empty string if no project file was found.
bool	reportMissingAltTextForImages ()
bool	singleExec () const
bool	dualExec () const
QStringList &	defines ()
QStringList &	dependModules ()
QStringList &	includePaths ()
QStringList &	indexDirs ()
QString	currentDir () const
void	setCurrentDir (const QString &pathpath)
QString	previousCurrentDir () const
void	setPreviousCurrentDir (const QString &pathpath)
void	setQDocPass (const QDocPass &pass)
bool	preparing () const
bool	generating () const
const ExcludedPaths &	getExcludedPaths ()
QSet< QString >	getInternalFilePatterns () const
	Returns the set of file patterns that identify internal implementation files.
const InternalFilePatterns &	getInternalFilePatternsCompiled ()
	Returns a reference to the pre-compiled internal file patterns structure.
const SourceLink &	getSourceLink ()
	Returns a SourceLink struct with settings required to construct source links to API entities.
std::set< HeaderFilePath >	getHeaderFiles ()
InclusionPolicy	createInclusionPolicy () const
Public Member Functions inherited from Singleton< Config >
	Singleton (const Singleton &)=delete
Singleton &	operator= (const Singleton &)=delete
void	setThing (int vv)
Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
	Constructs an object with parent object parent.
virtual	~QObject ()
	Destroys the object, deleting all its child objects.
virtual bool	event (QEvent *event)
	This virtual function receives events to an object and should return true if the event e was recognized and processed.
virtual bool	eventFilter (QObject watched, QEvent eventevent)
	Filters events if this object has been installed as an event filter for the watched object.
QString	objectName () const
Q_WEAK_OVERLOAD void	setObjectName (const QString &namename)
	Sets the object's name to name.
void	setObjectName (QAnyStringView namename)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
QBindable< QString >	bindableObjectName ()
bool	isWidgetType () const
	Returns `true` if the object is a widget; otherwise returns `false`.
bool	isWindowType () const
	Returns `true` if the object is a window; otherwise returns `false`.
bool	isQuickItemType () const
	Returns `true` if the object is a QQuickItem; otherwise returns `false`.
bool	isQmlExposed () const noexcept
	Returns whether the object has been created by the QML engine or ownership has been explicitly set via QJSEngine::setObjectOwnership().
bool	signalsBlocked () const noexcept
	Returns `true` if signals are blocked; otherwise returns `false`.
bool	blockSignals (bool b) noexcept
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
QThread *	thread () const
	Returns the thread in which the object lives.
bool	moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
	Changes the thread affinity for this object and its children and returns `true` on success.
int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
	This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
int	startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
void	killTimer (int idid)
	Kills the timer with timer identifier, id.
void	killTimer (Qt::TimerId idid)
template<typename T>
T	findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
template<typename T>
QList< T >	findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
template<typename T>
T	findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<typename T>
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
const QObjectList &	children () const
	Returns a list of child objects.
void	setParent (QObject *parent)
	Makes the object a child of parent.
void	installEventFilter (QObject *filterObj)
	Installs an event filter filterObj on this object.
void	removeEventFilter (QObject *objobj)
	Removes an event filter object obj from this object.
QMetaObject::Connection	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType typetype=Qt::AutoConnection) const
bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *member=nullptr) const
bool	disconnect (const QObject receiver, const char member=nullptr) const
void	dumpObjectTree () const
	Dumps a tree of children to the debug output.
void	dumpObjectInfo () const
	Dumps information about signal connections, etc.
bool	setProperty (const char *namename, const QVariant &valuevalue)
	Sets the value of the object's name property to value.
bool	setProperty (const char *namename, QVariant &&valuevalue)
QVariant	property (const char *namename) const
	Returns the value of the object's name property.
QList< QByteArray >	dynamicPropertyNames () const
QBindingStorage *	bindingStorage ()
const QBindingStorage *	bindingStorage () const
QObject *	parent () const
	Returns a pointer to the parent object.
bool	inherits (const char *classname) const
	Returns `true` if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns `false`.

Static Public Member Functions
static QStringList	loadMaster (const QString &fileName)
	fileName is a master qdocconf file.
static bool	isFileExcluded (const QString &fileName, const QSet< QString > &excludedFiles)
static QStringList	getFilesHere (const QString &dir, const QString &nameFilter, const Location &locationlocation=Location(), const QSet< QString > &excludedDirs=QSet< QString >(), const QSet< QString > &excludedFiles=QSet< QString >())
static QString	findFile (const Location &locationlocation, const QStringList &files, const QStringList &dirs, const QString &fileName, QString *userFriendlyFilePath=nullptr)
	fileName is the path of the file to find.
static QString	copyFile (const Location &locationlocation, const QString &sourceFilePath, const QString &userFriendlySourceFilePath, const QString &targetDirPath)
	Copies the sourceFilePath to the file name constructed by concatenating targetDirPath and the file name from the userFriendlySourceFilePath.
static int	numParams (const QString &valuevalue)
	Finds the largest unicode digit in value in the range 1..7 and returns it.
static void	pushWorkingDir (const QString &dir)
	Set dir as the working directory and push it onto the stack of working directories.
static void	popWorkingDir ()
	Pop the top entry from the stack of working directories.
static bool	matchesInternalFilePattern (const QString &filePath, const InternalFilePatterns &patterns) noexcept
	Returns true if the given filePath matches any pattern in the patterns structure.
Static Public Member Functions inherited from Singleton< Config >
static Config &	instance ()
Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)
	\threadsafe
static QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType typetype=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType context, Func2 &&slot, Qt::ConnectionType typetype=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)
	\threadsafe
static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)
static bool	disconnect (const QMetaObject::Connection &)
	Disconnects connection and resets it to \l{QMetaObject::Connection::operator bool()}{invalid}.
static bool	disconnect (QMetaObject::Connection &)
static bool	disconnect (QMetaObject::Connection &&conn)
	Disconnect a connection.
template<typename Func1, typename Func2>
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)
template<typename Func1>
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)

Static Public Attributes
static const QString	dot = QLatin1String(".")
static bool	generateExamples = true
static bool	parseCppComments = true
static QString	installDir
static QString	overrideOutputDir
static QSet< QString >	overrideOutputFormats

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe
Signals inherited from Singleton< Config >
void	thingChanged ()
Signals inherited from QObject
void	destroyed (QObject *=nullptr)
	This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
void	objectNameChanged (const QString &objectName, QPrivateSignal)
	This signal is emitted after the object's name has been changed.
Protected Member Functions inherited from QObject
QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
int	senderSignalIndex () const
int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal.
bool	isSignalConnected (const QMetaMethod &signal) const
virtual void	timerEvent (QTimerEvent *eventevent)
	This event handler can be reimplemented in a subclass to receive timer events for the object.
virtual void	childEvent (QChildEvent *eventevent)
	This event handler can be reimplemented in a subclass to receive child events.
virtual void	customEvent (QEvent *eventevent)
	This event handler can be reimplemented in a subclass to receive custom events.
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	disconnectNotify (const QMetaMethod &signal)
	QObject (QObjectPrivate &dd, QObject *parent=nullptr)
Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr
Properties inherited from Singleton< Config >
int	thing
Properties inherited from QObject
QString	objectName
	the name of this object
Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *objectobject)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
template< typename T > T	qFindChildqFindChildren (const QObject *objobj, const QString &namename)()
template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *objobj, const QString &namename)()
	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

The Config class contains the configuration variables for controlling how qdoc produces documentation.

Its load() function reads, parses, and processes a qdocconf file.

Definition at line 94 of file config.h.

Member Enumeration Documentation

◆ PathFlags

enum Config::PathFlags : unsigned char

Flags used for retrieving canonicalized paths from Config.

\value Validate Issue a warning for paths that do not exist and remove them from the returned list.

\value IncludePaths Assume the variable contains include paths with prefixes such as {-I} that are to be removed before canonicalizing and then re-inserted.

\omitvalue None

See also: getCanonicalPathList()

Enumerator
None
Validate
IncludePaths

Definition at line 101 of file config.h.

◆ QDocPass

enum Config::QDocPass

Enumerator
Neither
Prepare
Generate

Definition at line 99 of file config.h.

Constructor & Destructor Documentation

◆ ~Config()

Config::~Config ( )

Definition at line 397 of file config.cpp.

References clear().

Here is the call graph for this function:

Member Function Documentation

◆ clear()

void Config::clear ( )

Clears the location and internal maps for config variables.

Definition at line 405 of file config.cpp.

Referenced by ~Config(), and reset().

Here is the caller graph for this function:

◆ contains()

bool Config::contains ( const QString & var ) const

inlinenodiscard

Returns true if var exists in the configuration, including defaults and programmatically inserted values. An explicitly empty declaration counts as present. This tests presence, not the value's truth or validity.

Unlike the fallback returned by {get()}, this query distinguishes an absent variable without inserting a default-constructed entry.

Definition at line 146 of file config.h.

◆ copyFile()

QString Config::copyFile	(	const Location &	location,
		const QString &	sourceFilePath,
		const QString &	userFriendlySourceFilePath,
		const QString &	targetDirPath )

static

Copies the sourceFilePath to the file name constructed by concatenating targetDirPath and the file name from the userFriendlySourceFilePath.

location is for identifying the file and line number where a qdoc error occurred. The constructed output file name is returned.

Definition at line 1035 of file config.cpp.

◆ createInclusionPolicy()

InclusionPolicy Config::createInclusionPolicy ( ) const

Definition at line 1678 of file config.cpp.

References includePrivateFunction(), includePrivateType(), includePrivateVariable(), showAutoGeneratedDocs(), and showInternal().

Referenced by generateIndexFile(), WebXMLGenerator::generateIndexSections(), and TemplateGenerator::prepare().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ currentDir()

QString Config::currentDir ( ) const

inlinenodiscard

Definition at line 195 of file config.h.

◆ defines()

QStringList & Config::defines ( )

inline

Definition at line 191 of file config.h.

◆ dependModules()

QStringList & Config::dependModules ( )

inline

Definition at line 192 of file config.h.

◆ dualExec()

bool Config::dualExec ( ) const

inlinenodiscard

Definition at line 485 of file config.h.

Referenced by processQdocconfFile().

Here is the caller graph for this function:

◆ findFile()

QString Config::findFile	(	const Location &	location,
		const QStringList &	files,
		const QStringList &	dirs,
		const QString &	fileName,
		QString *	userFriendlyFilePath = nullptr )

static

fileName is the path of the file to find.

files and dirs are the lists where we must find the components of fileName.

location is used for obtaining the file and line numbers for report qdoc errors.

Definition at line 951 of file config.cpp.

◆ generating()

bool Config::generating ( ) const

inlinenodiscard

Definition at line 202 of file config.h.

References Generate.

Referenced by generateIndexFile(), and Generator::initializeFormat().

Here is the caller graph for this function:

◆ get()

const ConfigVar & Config::get ( const QString & var ) const

inlinenodiscard

Definition at line 138 of file config.h.

◆ getAllFiles()

QStringList Config::getAllFiles	(	const QString &	filesVar,
		const QString &	dirsVar,
		const QSet< QString > &	excludedDirs = QSet<QString>(),
		const QSet< QString > &	excludedFiles = QSet<QString>() )

Builds and returns a list of file pathnames for the file type specified by filesVar (e.g.

"headers" or "sources"). The files are found in the directories specified by dirsVar, and they are filtered by defaultNameFilter if a better filter can't be constructed from filesVar. The directories in excludedDirs are avoided. The files in excludedFiles are not included in the return list.

Definition at line 853 of file config.cpp.

◆ getAtomsDump()

bool Config::getAtomsDump ( ) const

inlinenodiscard

Definition at line 120 of file config.h.

◆ getCanonicalPathList()

QStringList Config::getCanonicalPathList	(	const QString &	var,
		PathFlags	flags = None ) const

nodiscard

Returns a path list where all paths from the config variable var are canonicalized.

If flags contains Validate, outputs a warning for invalid paths. The IncludePaths flag is used as a hint to strip away potential prefixes found in include paths before attempting to canonicalize.

Definition at line 696 of file config.cpp.

◆ getDebug()

bool Config::getDebug ( ) const

inlinenodiscard

Definition at line 119 of file config.h.

Referenced by processQdocconfFile().

Here is the caller graph for this function:

◆ getExampleImageFiles()

QStringList Config::getExampleImageFiles	(	const QSet< QString > &	excludedDirs,
		const QSet< QString > &	excludedFiles )

Definition at line 879 of file config.cpp.

◆ getExampleProjectFile()

QString Config::getExampleProjectFile ( const QString & examplePath )

Returns the path to the project file for examplePath, or an empty string if no project file was found.

Definition at line 902 of file config.cpp.

◆ getExampleQdocFiles()

QStringList Config::getExampleQdocFiles	(	const QSet< QString > &	excludedDirs,
		const QSet< QString > &	excludedFiles )

Definition at line 867 of file config.cpp.

◆ getExcludedPaths()

const Config::ExcludedPaths & Config::getExcludedPaths ( )

Definition at line 1509 of file config.cpp.

Referenced by getHeaderFiles(), and processQdocconfFile().

Here is the caller graph for this function:

◆ getFilesHere()

QStringList Config::getFilesHere	(	const QString &	dir,
		const QString &	nameFilter,
		const Location &	location = Location(),
		const QSet< QString > &	excludedDirs = QSet<QString>(),
		const QSet< QString > &	excludedFiles = QSet<QString>() )

static

Definition at line 1448 of file config.cpp.

◆ getHeaderFiles()

std::set< Config::HeaderFilePath > Config::getHeaderFiles ( )

Definition at line 1649 of file config.cpp.

References getExcludedPaths().

Here is the call graph for this function:

◆ getIncludeFilePath()

QString Config::getIncludeFilePath ( const QString & fileName ) const

nodiscard

Searches for a path to fileName in 'sources', 'sourcedirs', and 'exampledirs' config variables and returns a full path to the first match found.

If the file is not found, returns an empty string.

Definition at line 815 of file config.cpp.

◆ getInternalFilePatterns()

QSet< QString > Config::getInternalFilePatterns ( ) const

nodiscard

Returns the set of file patterns that identify internal implementation files.

Classes declared in files matching these patterns will have their nodes marked as internal, excluding them and their members from documentation requirements when showInternal is false.

See also: isFileExcluded()

Definition at line 1532 of file config.cpp.

◆ getInternalFilePatternsCompiled()

const Config::InternalFilePatterns & Config::getInternalFilePatternsCompiled ( )

Returns a reference to the pre-compiled internal file patterns structure.

This method caches the compiled patterns for efficient reuse across multiple file checks. The patterns are compiled once when first accessed and remain valid until the configuration is cleared or reloaded.

The returned structure separates patterns into:

exactMatches: Patterns without wildcards for direct string matching.
regexPatterns: Pre-compiled regular expressions for regular expression patterns.

See also: matchesInternalFilePattern(), clear()

Definition at line 1551 of file config.cpp.

◆ getOutputDir()

QString Config::getOutputDir ( const QString & format = QString("HTML") ) const

nodiscard

Function to return the correct outputdir for the output format.

If format is not specified, defaults to 'HTML'. outputdir can be set using the qdocconf or the command-line variable –outputdir.

Definition at line 620 of file config.cpp.

◆ getOutputFormats()

QSet< QString > Config::getOutputFormats ( ) const

nodiscard

Function to return the correct outputformats.

outputformats can be set using the qdocconf or the command-line variable –outputformat.

Definition at line 667 of file config.cpp.

◆ getRegExp()

QRegularExpression Config::getRegExp ( const QString & var ) const

nodiscard

Calls getRegExpList() with the control variable var and iterates through the resulting list of regular expressions, concatenating them with extra characters to form a single QRegularExpression, which is then returned.

See also: getRegExpList()

Definition at line 757 of file config.cpp.

◆ getRegExpList()

QList< QRegularExpression > Config::getRegExpList ( const QString & var ) const

nodiscard

Looks up the configuration variable var in the string list map, converts the string list to a list of regular expressions, and returns it.

Definition at line 779 of file config.cpp.

◆ getSourceLink()

const Config::SourceLink & Config::getSourceLink ( )

Returns a SourceLink struct with settings required to construct source links to API entities.

Definition at line 1633 of file config.cpp.

◆ includePaths()

QStringList & Config::includePaths ( )

inline

Definition at line 193 of file config.h.

◆ includePrivate()

bool Config::includePrivate ( ) const

inlinenodiscard

Definition at line 490 of file config.h.

Referenced by includePrivateFunction(), includePrivateType(), and includePrivateVariable().

Here is the caller graph for this function:

◆ includePrivateFunction()

bool Config::includePrivateFunction ( ) const

inlinenodiscard

Definition at line 495 of file config.h.

References includePrivate().

Referenced by createInclusionPolicy().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ includePrivateType()

bool Config::includePrivateType ( ) const

inlinenodiscard

Definition at line 501 of file config.h.

References includePrivate().

Referenced by createInclusionPolicy().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ includePrivateVariable()

bool Config::includePrivateVariable ( ) const

inlinenodiscard

Definition at line 507 of file config.h.

References includePrivate().

Referenced by createInclusionPolicy().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ indexDirs()

QStringList & Config::indexDirs ( )

inline

Definition at line 194 of file config.h.

◆ init()

void Config::init	(	const QString &	programName,
		const QStringList &	args )

Initializes the Config with programName and sets all internal state variables to either default values or to ones defined in command line arguments args.

Definition at line 390 of file config.cpp.

References reset().

Here is the call graph for this function:

◆ insertStringList()

void Config::insertStringList	(	const QString &	var,
		const QStringList &	values )

Adds the values from a string list to the configuration variable var.

Existing value(s) are kept.

Definition at line 541 of file config.cpp.

◆ isFileExcluded()

bool Config::isFileExcluded	(	const QString &	fileName,
		const QSet< QString > &	excludedFiles )

static

Definition at line 1435 of file config.cpp.

◆ load()

void Config::load ( const QString & fileName )

Loads and parses the qdoc configuration file fileName.

If a previous project was loaded, this function first resets the Config instance. Then it calls the other load() function, which does the loading, parsing, and processing of the configuration file.

Definition at line 453 of file config.cpp.

References parseCppComments, and reset().

Here is the call graph for this function:

◆ loadMaster()

QStringList Config::loadMaster ( const QString & fileName )

static

fileName is a master qdocconf file.

It contains a list of qdocconf files and nothing else. Read the list and return it.

Definition at line 1148 of file config.cpp.

◆ location()

const Location & Config::location ( ) const

inlinenodiscard

Definition at line 137 of file config.h.

Referenced by processQdocconfFile().

Here is the caller graph for this function:

◆ matchesInternalFilePattern()

bool Config::matchesInternalFilePattern	(	const QString &	filePath,
		const InternalFilePatterns &	patterns )

staticnoexcept

Returns true if the given filePath matches any pattern in the patterns structure.

This is an optimized version that uses pre-compiled regular expressions.

The function first checks for exact matches (patterns without wildcards), which compare against the full normalized path. Then it checks glob patterns against the filename only, and finally regex patterns against the full path.

Path normalization is handled internally: all backslashes are converted to forward slashes to ensure cross-platform consistency, as patterns are expected to use forward slashes.

See also: getInternalFilePatternsCompiled()

Definition at line 1602 of file config.cpp.

◆ numParams()

int Config::numParams ( const QString & value )

static

Finds the largest unicode digit in value in the range 1..7 and returns it.

Definition at line 1123 of file config.cpp.

◆ popWorkingDir()

void Config::popWorkingDir ( )

static

Pop the top entry from the stack of working directories.

Set the working directory to the next one on the stack, if one exists.

Definition at line 1501 of file config.cpp.

◆ preparing()

bool Config::preparing ( ) const

inlinenodiscard

Definition at line 201 of file config.h.

References Prepare.

Referenced by HtmlGenerator::generateDocs(), Generator::initializeFormat(), and processQdocconfFile().

Here is the caller graph for this function:

◆ previousCurrentDir()

QString Config::previousCurrentDir ( ) const

inlinenodiscard

Definition at line 197 of file config.h.

◆ programName()

const QString & Config::programName ( ) const

inlinenodiscard

Definition at line 136 of file config.h.

◆ pushWorkingDir()

void Config::pushWorkingDir ( const QString & dir )

static

Set dir as the working directory and push it onto the stack of working directories.

Definition at line 1490 of file config.cpp.

◆ qdocFiles()

QStringList Config::qdocFiles ( ) const

inlinenodiscard

Definition at line 135 of file config.h.

◆ reportMissingAltTextForImages()

bool Config::reportMissingAltTextForImages ( )

inline

Definition at line 179 of file config.h.

◆ reset()

void Config::reset ( )

Resets the Config instance and loads the default values.

A subset of command line options are published as configuration variables.

Definition at line 419 of file config.cpp.

References clear().

Referenced by init(), and load().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCurrentDir()

void Config::setCurrentDir ( const QString & path )

inline

Definition at line 196 of file config.h.

◆ setPreviousCurrentDir()

void Config::setPreviousCurrentDir ( const QString & path )

inline

Definition at line 198 of file config.h.

◆ setQDocPass()

void Config::setQDocPass ( const QDocPass & pass )

inline

Definition at line 200 of file config.h.

◆ setStringList()

void Config::setStringList	(	const QString &	var,
		const QStringList &	values )

Sets the values of a configuration variable var from a string list.

Definition at line 532 of file config.cpp.

◆ showAutoGeneratedDocs()

bool Config::showAutoGeneratedDocs ( ) const

nodiscard

Definition at line 1673 of file config.cpp.

Referenced by createInclusionPolicy().

Here is the caller graph for this function:

◆ showHelp()

void Config::showHelp ( int exitCode = 0 )

inline

Definition at line 134 of file config.h.

◆ showInternal()

bool Config::showInternal ( ) const

inlinenodiscard

Definition at line 121 of file config.h.

Referenced by createInclusionPolicy().

Here is the caller graph for this function:

◆ singleExec()

bool Config::singleExec ( ) const

inlinenodiscard

Definition at line 480 of file config.h.

Referenced by generateIndexFile(), Location::initialize(), and processQdocconfFile().

Here is the caller graph for this function:

◆ subVars()

QSet< QString > Config::subVars ( const QString & var ) const

nodiscard

This function is slower than it could be.

What it does is find all the keys that begin with var + dot and return the matching keys in a set, stripped of the matching prefix and dot.

Definition at line 794 of file config.cpp.

◆ variableNames()

QStringList Config::variableNames ( ) const

inlinenodiscard

Returns the configuration variable names in sorted order, including defaults and programmatic declarations. Reading the names does not insert undefined variables. Publication resolution uses this list to find recognized settings even when their formats do not occur in the effective request.

Definition at line 147 of file config.h.

Member Data Documentation

◆ dot

const QString Config::dot = QLatin1String(".")

static

Definition at line 181 of file config.h.

Referenced by processQdocconfFile().

◆ generateExamples

bool Config::generateExamples = true

static

Definition at line 183 of file config.h.

Referenced by CppCodeParser::processTopicCommand().

◆ installDir

QString Config::installDir

static

Definition at line 185 of file config.h.

◆ overrideOutputDir

QString Config::overrideOutputDir

static

Definition at line 186 of file config.h.

Referenced by generateIndexFile().

◆ overrideOutputFormats

QSet< QString > Config::overrideOutputFormats

static

Definition at line 187 of file config.h.

◆ parseCppComments

bool Config::parseCppComments = true

static

Definition at line 184 of file config.h.

Referenced by load(), and processQdocconfFile().

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

qttools/src/qdoc/qdoc/src/qdoc/config.h (3aae1deccb0aa5b8691e37ce573d85e601e0d34c)
qttools/src/qdoc/qdoc/src/qdoc/config.cpp (9531e6c604fa458f550f657fa02005e058283832)

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ PathFlags

◆ QDocPass

Constructor & Destructor Documentation

◆ ~Config()

Member Function Documentation

◆ clear()

◆ contains()

◆ copyFile()

◆ createInclusionPolicy()

◆ currentDir()

◆ defines()

◆ dependModules()

◆ dualExec()

◆ findFile()

◆ generating()

◆ get()

◆ getAllFiles()

◆ getAtomsDump()

◆ getCanonicalPathList()

◆ getDebug()

◆ getExampleImageFiles()

◆ getExampleProjectFile()

◆ getExampleQdocFiles()

◆ getExcludedPaths()

◆ getFilesHere()

◆ getHeaderFiles()

◆ getIncludeFilePath()

◆ getInternalFilePatterns()

◆ getInternalFilePatternsCompiled()

◆ getOutputDir()

◆ getOutputFormats()

◆ getRegExp()

◆ getRegExpList()

◆ getSourceLink()

◆ includePaths()

◆ includePrivate()

◆ includePrivateFunction()

◆ includePrivateType()

◆ includePrivateVariable()

◆ indexDirs()

◆ init()

◆ insertStringList()

◆ isFileExcluded()

◆ load()

◆ loadMaster()

◆ location()

◆ matchesInternalFilePattern()

◆ numParams()

◆ popWorkingDir()

◆ preparing()

◆ previousCurrentDir()

◆ programName()

◆ pushWorkingDir()

◆ qdocFiles()

◆ reportMissingAltTextForImages()

◆ reset()

◆ setCurrentDir()

◆ setPreviousCurrentDir()

◆ setQDocPass()

◆ setStringList()

◆ showAutoGeneratedDocs()

◆ showHelp()

◆ showInternal()

◆ singleExec()

◆ subVars()

◆ variableNames()

Member Data Documentation

◆ dot

◆ generateExamples

◆ installDir

◆ overrideOutputDir

◆ overrideOutputFormats