Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Toggle main menu visibility
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"
8
#
include
"outputdirectory.h"
9
10
#
include
<
QtCore
/
qhash
.
h
>
11
#
include
<
QtCore
/
qstring
.
h
>
12
13
QT_BEGIN_NAMESPACE
14
15
class
Config
;
16
17
struct
OutputContext
18
{
19
OutputDirectory
outputDir
;
20
QString
project
;
21
QString
subdir
;
22
QString
fileExtension
;
23
QHash
<
QString
,
QString
>
outputPrefixes
;
24
QHash
<
QString
,
QString
>
outputSuffixes
;
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
35
QT_END_NAMESPACE
36
37
#
endif
// OUTPUTCONTEXT_H
Config
The Config class contains the configuration variables for controlling how qdoc produces documentation...
Definition
config.h:95
Location
The Location class provides a way to mark a location in a file.
Definition
location.h:20
Location::Location
Location()
Constructs an empty location.
Definition
location.cpp:50
OutputDirectory
Represents an output directory that has been verified to exist.
Definition
outputdirectory.h:16
QT_BEGIN_NAMESPACE
Combined button and popup list for selecting options.
Definition
qsequentialanimationgroup.cpp:47
OutputContext
Bundles output configuration without static variables.
Definition
outputcontext.h:18
OutputContext::autolinkErrors
bool autolinkErrors
Definition
outputcontext.h:27
OutputContext::noLinkErrors
bool noLinkErrors
Definition
outputcontext.h:26
OutputContext::useSubdirs
bool useSubdirs
Definition
outputcontext.h:25
OutputContext::outputPrefix
QString outputPrefix(Genus genus) const
Returns the output prefix for the given genus.
Definition
outputcontext.cpp:127
OutputContext::outputPrefixes
QHash< QString, QString > outputPrefixes
Definition
outputcontext.h:23
OutputContext::outputSuffix
QString outputSuffix(Genus genus) const
Returns the output suffix for the given genus.
Definition
outputcontext.cpp:136
OutputContext::project
QString project
Definition
outputcontext.h:20
OutputContext::fromConfig
static OutputContext fromConfig(const Config &config, const QString &format)
Creates an OutputContext from the given config for the specified output format.
Definition
outputcontext.cpp:53
OutputContext::outputSuffixes
QHash< QString, QString > outputSuffixes
Definition
outputcontext.h:24
OutputContext::fileExtension
QString fileExtension
Definition
outputcontext.h:22
OutputContext::subdir
QString subdir
Definition
outputcontext.h:21
OutputContext::outputDir
OutputDirectory outputDir
Definition
outputcontext.h:19
qttools
src
qdoc
qdoc
src
qdoc
outputcontext.h
Generated on
for Qt by
1.18.0