diff options
author | Allan Sandfeld Jensen <allan.jensen@qt.io> | 2022-04-20 11:27:45 +0200 |
---|---|---|
committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2022-04-23 19:26:43 +0000 |
commit | 381e14f7fe7448c38240be41b4098d2806ad5925 (patch) | |
tree | b358613a774fcc9aa5049a30a57d1678b5f1722e | |
parent | 6d2c9083243cfbf012706ea27353c287569464af (diff) |
Fix documentation of getter functions
Add documentation file in doc dir, and add a related header as a
documented header file.
Fixes: QTBUG-102743
Change-Id: Ibcbc39affe1915b0606e879a9ec5a1189f2d5aea
Reviewed-by: Michal Klocek <michal.klocek@qt.io>
(cherry picked from commit a6efb817b3596131f1885d8f7b2d4d760141b169)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r-- | src/core/doc/src/qtwebengine-global.qdoc | 66 | ||||
-rw-r--r-- | src/core/web_engine_context.cpp | 24 |
2 files changed, 66 insertions, 24 deletions
diff --git a/src/core/doc/src/qtwebengine-global.qdoc b/src/core/doc/src/qtwebengine-global.qdoc new file mode 100644 index 000000000..435fbac68 --- /dev/null +++ b/src/core/doc/src/qtwebengine-global.qdoc @@ -0,0 +1,66 @@ +/**************************************************************************** +** +** Copyright (C) 2022 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: https://www.gnu.org/licenses/fdl-1.3.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \headerfile <qtwebenginecoreglobal.h> + \inmodule QtWebEngineCore + \title Global Qt WebEngine Core Declarations + \ingroup funclists + + \brief Helper functions for the \QWE Core module. + +*/ + + +/*! + \fn const char *qWebEngineVersion() noexcept + \relates <qtwebenginecoreglobal.h> + \since 6.2 + + Returns the version number of \QWE at run-time as a string + (for example, "6.2.0"). This may be a different version than the + version the application was compiled against, and a different version + than Qt. +*/ + +/*! + \fn const char *qWebEngineChromiumVersion() noexcept + \relates <qtwebenginecoreglobal.h> + \since 6.2 + + Returns the version number of Chromium used by \QWE at run-time + as a string (for example, "83.0.4103.122"). +*/ + +/*! + \fn const char *qWebEngineChromiumSecurityPatchVersion() noexcept + \relates <qtwebenginecoreglobal.h> + \since 6.3 + + Returns the version number of last Chromium version security patches have been + merged from. +*/ diff --git a/src/core/web_engine_context.cpp b/src/core/web_engine_context.cpp index 522134500..cbb962707 100644 --- a/src/core/web_engine_context.cpp +++ b/src/core/web_engine_context.cpp @@ -887,39 +887,15 @@ bool WebEngineContext::closingDown() } // namespace QT_BEGIN_NAMESPACE -/*! - \relates <qtwebenginecoreglobal.h> - \since 6.2 - - Returns the version number of Qt WebEngine at run-time as a string - (for example, "6.2.0"). This may be a different version than the - version the application was compiled against, and a different version - than Qt. -*/ const char *qWebEngineVersion() noexcept { return QTWEBENGINECORE_VERSION_STR; } -/*! - \relates <qtwebenginecoreglobal.h> - \since 6.2 - - Returns the version number of Chromium used by Qt WebEngine at run-time - as a string (for example, "83.0.4103.122"). -*/ const char *qWebEngineChromiumVersion() noexcept { return CHROMIUM_VERSION; } - -/*! - \relates <qtwebenginecoreglobal.h> - \since 6.3 - - Returns the version number of last Chromium version security patches have been - merged from. -*/ const char *qWebEngineChromiumSecurityPatchVersion() noexcept { return "99.0.4844.84"; // FIXME: Remember to update |