Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
outputcontext.h
Go to the documentation of this file.
1// Copyright (C) 2026 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
3
4#ifndef OUTPUTCONTEXT_H
5#define OUTPUTCONTEXT_H
6
8
9#include <QtCore/qhash.h>
10#include <QtCore/qstring.h>
11
13
14class Config;
15
17{
24 bool useSubdirs{true};
25 bool noLinkErrors{false};
26 bool autolinkErrors{false};
27
28 [[nodiscard]] static OutputContext fromConfig(const Config &config,
29 const QString &format);
30 [[nodiscard]] QString outputPrefix(const QString &nodeType) const;
31 [[nodiscard]] QString outputSuffix(const QString &nodeType) const;
32};
33
34QT_END_NAMESPACE
35
36#endif // OUTPUTCONTEXT_H
The Config class contains the configuration variables for controlling how qdoc produces documentation...
Definition config.h:85
The Location class provides a way to mark a location in a file.
Definition location.h:20
Location()
Constructs an empty location.
Definition location.cpp:48
Represents an output directory that has been verified to exist.
Combined button and popup list for selecting options.
Bundles output configuration without static variables.
QString outputSuffix(const QString &nodeType) const
Returns the output suffix for the given nodeType.
QHash< QString, QString > outputPrefixes
static OutputContext fromConfig(const Config &config, const QString &format)
Creates an OutputContext from the given config for the specified output format.
QHash< QString, QString > outputSuffixes
QString outputPrefix(const QString &nodeType) const
Returns the output prefix for the given nodeType.
QString fileExtension
OutputDirectory outputDir