summaryrefslogtreecommitdiffstats
path: root/src/corelib/text/qtliterals.qdoc
blob: 8be03a02236da305c54172c938d4aff07bd642fa (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
// Copyright (C) 2021 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
// Qt-Security score:insignificant reason:docs

/*!
    \namespace QtLiterals
    \inmodule QtCore

    \brief The QtLiterals namespace declares literal operators for Qt types.
*/

/*!
    \namespace Qt::Literals
    \inmodule QtCore
    \inheaderfile QString

    \brief The Literals inline namespace declares literal operators for Qt types.
*/

/*!
    \namespace Qt::Literals::StringLiterals
    \inmodule QtCore
    \inheaderfile QString

    \brief The StringLiterals namespace declares literal operators for Qt
    string types.

    The inline Qt::Literals::StringLiterals namespace declares literal operators
    for Qt string types. Because both \c Literals and \c StringLiterals
    namespaces are declared as inline, the symbols from this namespace can be
    accessed by adding one of the following to your code:

    \code
    // Makes visible only the literal operators declared in StringLiterals
    using namespace Qt::StringLiterals;
    // same, but needlessly verbose:
    using namespace Qt::Literals::StringLiterals;

    // Makes visible literal operators declared in all inline namespaces
    // inside Literals
    using namespace Qt::Literals;

    // Makes visible all symbols (including all literal operators) declared
    // in the Qt namespace
    using namespace Qt;
    \endcode

    The latter is discouraged, because it doesn't allow you to pick which literal
    operators you want in case Qt adds conflicting operators in different
    namespaces within Qt::Literals.
*/