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
7#include "genustypes.h"
9
10#include <QtCore/qhash.h>
11#include <QtCore/qstring.h>
12
14
15class Config;
16
18{
25 bool useSubdirs{true};
26 bool noLinkErrors{false};
27 bool autolinkErrors{false};
28
29 [[nodiscard]] static OutputContext fromConfig(const Config &config,
30 const QString &format);
31 [[nodiscard]] QString outputPrefix(Genus genus) const;
32 [[nodiscard]] QString outputSuffix(Genus genus) const;
33};
34
35QT_END_NAMESPACE
36
37#endif // OUTPUTCONTEXT_H
The Config class contains the configuration variables for controlling how qdoc produces documentation...
Definition config.h:95
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 outputPrefix(Genus genus) const
Returns the output prefix for the given genus.
QHash< QString, QString > outputPrefixes
QString outputSuffix(Genus genus) const
Returns the output suffix for the given genus.
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 fileExtension
OutputDirectory outputDir