summaryrefslogtreecommitdiffstats
path: root/doc/global
diff options
context:
space:
mode:
authorLeander Beernaert <leander.beernaert@qt.io>2020-01-22 13:47:08 +0100
committerLeander Beernaert <leander.beernaert@qt.io>2020-01-24 13:17:33 +0100
commit502d3d6744913899da87acfda5ebdab42c40329e (patch)
tree16658a328503bfd5a62b4fd5d69ffb66e9854b18 /doc/global
parentd1be8b9ceb2c7b20bbe53a07154c79699540ea3d (diff)
parent06bb315beb6c2c398223cfe52cbc7f66e14a8557 (diff)
Merge remote-tracking branch 'origin/dev' into merge-dev
Diffstat (limited to 'doc/global')
-rw-r--r--doc/global/config.qdocconf2
-rw-r--r--doc/global/html-footer-online.qdocconf2
-rw-r--r--doc/global/html-footer.qdocconf2
-rw-r--r--doc/global/includes/standardpath/functiondocs.qdocinc129
-rw-r--r--doc/global/macros.qdocconf76
-rw-r--r--doc/global/qt-module-defaults-online.qdocconf2
6 files changed, 172 insertions, 41 deletions
diff --git a/doc/global/config.qdocconf b/doc/global/config.qdocconf
index 16d4e5c63a..8df9b4f30d 100644
--- a/doc/global/config.qdocconf
+++ b/doc/global/config.qdocconf
@@ -3,7 +3,7 @@
dita.metadata.default.author = Qt Project
dita.metadata.default.permissions = all
dita.metadata.default.publisher = Qt Project
-dita.metadata.default.copyryear = 2019
+dita.metadata.default.copyryear = 2020
dita.metadata.default.copyrholder = The Qt Company Ltd
dita.metadata.default.audience = programmer
diff --git a/doc/global/html-footer-online.qdocconf b/doc/global/html-footer-online.qdocconf
index c4465fce66..f255726c1d 100644
--- a/doc/global/html-footer-online.qdocconf
+++ b/doc/global/html-footer-online.qdocconf
@@ -78,7 +78,7 @@ HTML.footer += \
" <ul id=\"menu-footer-submenu\" class=\"right clearfix\"><li id=\"menu-item-1795\" class=\"menu-item menu-item-type-custom menu-item-object-custom menu-item-1795\"><a title=\"Sign into your account.\" href=\"https://account.qt.io/login\">Sign In</a></li>\n" \
" <li id=\"menu-item-10375\" class=\"menu-item menu-item-type-custom menu-item-object-custom menu-item-10375\"><a href=\"mailto:feedback@theqtcompany.com?Subject=Feedback%20about%20doc.qt.io%20site\">Feedback</a></li>\n" \
" <li id=\"menu-item-1494\" class=\"menu-item menu-item-type-post_type menu-item-object-page menu-item-1494\"><a href=\"http://qt.io/contact-us/\">Contact us</a></li>\n" \
- " <li id=\"menu-item-4472\" class=\"menu-item menu-item-type-custom menu-item-object-custom menu-item-4472\"><a href=\"http://qt.io/about-us/\">© 2019 The Qt Company</a></li>\n" \
+ " <li id=\"menu-item-4472\" class=\"menu-item menu-item-type-custom menu-item-object-custom menu-item-4472\"><a href=\"http://qt.io/about-us/\">© 2020 The Qt Company</a></li>\n" \
" </ul>\n" \
"</div>\n" \
"</div>\n" \
diff --git a/doc/global/html-footer.qdocconf b/doc/global/html-footer.qdocconf
index 04f7fa0d79..5c29851e90 100644
--- a/doc/global/html-footer.qdocconf
+++ b/doc/global/html-footer.qdocconf
@@ -8,7 +8,7 @@ HTML.footer = \
"</div>\n" \
"<div class=\"footer\">\n" \
" <p>\n" \
- " <acronym title=\"Copyright\">&copy;</acronym> 2019 The Qt Company Ltd.\n" \
+ " <acronym title=\"Copyright\">&copy;</acronym> 2020 The Qt Company Ltd.\n" \
" Documentation contributions included herein are the copyrights of\n" \
" their respective owners.<br/>" \
" The documentation provided herein is licensed under the terms of the" \
diff --git a/doc/global/includes/standardpath/functiondocs.qdocinc b/doc/global/includes/standardpath/functiondocs.qdocinc
new file mode 100644
index 0000000000..4385b6446d
--- /dev/null
+++ b/doc/global/includes/standardpath/functiondocs.qdocinc
@@ -0,0 +1,129 @@
+/****************************************************************************
+**
+** Copyright (C) 2019 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$
+**
+****************************************************************************/
+
+//! [displayName]
+
+ Returns a localized display name for the given location \a type
+ or an empty QString if no relevant location can be found.
+
+//! [displayName]
+
+
+//! [findExecutable]
+
+ Finds the executable named \a executableName in the specified
+ \a paths, or the system paths if paths is empty.
+
+ On most operating systems the system path is determined by the
+ \c PATH environment variable. The directories where to search for
+ the executable can be set in the paths argument. To search in
+ both your own paths and the system paths, call findExecutable
+ twice, once with paths set and once with paths empty.
+ Symlinks are not resolved in order to preserve behavior for the
+ case of executables whose behavior depends on the name they are
+ invoked with
+ .
+ \note On Windows, the usual executable extensions (from the PATHEXT
+ environment variable) are automatically appended. For example, the
+ findExecutable("foo") call finds \c foo.exe or \c foo.bat if
+ present.
+
+ Returns the absolute file path to the executable, or an empty
+ string if not found.
+
+//! [findExecutable]
+
+//! [locate]
+
+ Finds a file or directory called \a fileName in the standard
+ locations for \a type.
+
+ The \a options flag lets you specify whether to look for files
+ or directories. By default, this flag is set to \c LocateFile.
+
+ Returns the absolute path to the first file or directory found,
+ otherwise returns an empty string.
+
+//! [locate]
+
+//! [locateAll]
+
+ Finds all files or directories by the name, \a fileName, in the
+ standard locations for \a type.
+
+ The \a options flag lets you specify whether to look for files
+ or directories. By default, this flag is set to \c LocateFile.
+
+ Returns the list of all the files that were found.
+
+//! [locateAll]
+
+//! [setTestModeEnabled]
+
+ If \a testMode is \c true, this enables a special "test mode" in
+ QStandardPaths, which changes writable locations to point to
+ test directories. This prevents auto tests from reading
+ or writing to the current user's configuration.
+
+ It affects the locations into which test programs might write
+ files: \c GenericDataLocation, \c DataLocation, \c ConfigLocation,
+ \c GenericConfigLocation, \c AppConfigLocation,
+ \c GenericCacheLocation, and \c CacheLocation. Other locations
+ are not affected.
+
+ On Unix, \c XDG_DATA_HOME is set to \c{~/.qttest/share},
+ \c XDG_CONFIG_HOME is set to \c{~/.qttest/config}, and
+ \c XDG_CACHE_HOME is set to \c{~/.qttest/cache}.
+
+ On macOS, data goes to \c{~/.qttest/Application Support},
+ cache goes to \c{~/.qttest/Cache}, and config goes to
+ \c{~/.qttest/Preferences}.
+
+ On Windows, everything goes to a "qttest" directory under
+ \c{%APPDATA%}.
+
+//! [setTestModeEnabled]
+
+//! [standardLocations]
+
+ Returns all the directories where files of \a type belong.
+
+ The list of directories is sorted from high to low priority,
+ starting with writableLocation() if it can be determined.
+ This list is empty if no locations for type are defined.
+
+//! [standardLocations]
+
+//! [writableLocation]
+
+ Returns the directory where files of \a type should be written to,
+ or an empty string if the location cannot be determined.
+
+ \note The storage location returned may not exist; that is,
+ it may need to be created by the system or the user.
+
+//! [writableLocation]
diff --git a/doc/global/macros.qdocconf b/doc/global/macros.qdocconf
index 72330cd16c..3a525224c1 100644
--- a/doc/global/macros.qdocconf
+++ b/doc/global/macros.qdocconf
@@ -1,40 +1,42 @@
-macro.aacute.HTML = "&aacute;"
-macro.Aring.HTML = "&Aring;"
-macro.aring.HTML = "&aring;"
-macro.Auml.HTML = "&Auml;"
-macro.author = "\\b{Author:}"
-macro.BR.HTML = "<br />"
-macro.copyright.HTML = "&copy;"
-macro.eacute.HTML = "&eacute;"
-macro.gui = "\\b"
-macro.HR.HTML = "<hr />"
-macro.iacute.HTML = "&iacute;"
-macro.key = "\\b"
-macro.macos = "macOS"
-macro.menu = "\\b"
-macro.oslash.HTML = "&oslash;"
-macro.ouml.HTML = "&ouml;"
-macro.nullptr = "\\c{nullptr}"
-macro.QA = "\\e{Qt Assistant}"
-macro.QD = "\\e{Qt Designer}"
-macro.QL = "\\e{Qt Linguist}"
-macro.Q_OBJECT = "Q_OBJECT"
-macro.QQV = "\\e{Qt QML Viewer}"
-macro.QtVersion = "$QT_VERSION"
-macro.QtVer = "$QT_VER"
-macro.param = "\\e"
-macro.raisedaster.HTML = "<sup>*</sup>"
-macro.rarrow.HTML = "&rarr;"
-macro.reg.HTML = "<sup>&reg;</sup>"
-macro.return = "Returns"
-macro.starslash = "\\c{*/}"
-macro.begincomment = "\\c{/*}"
-macro.endcomment = "\\c{*/}"
-macro.uuml.HTML = "&uuml;"
-macro.mdash.HTML = "&mdash;"
-macro.pi.HTML = "&Pi;"
-macro.beginqdoc.HTML = "/*!"
-macro.endqdoc.HTML = "*/"
+macro.aacute.HTML = "&aacute;"
+macro.Aring.HTML = "&Aring;"
+macro.aring.HTML = "&aring;"
+macro.Auml.HTML = "&Auml;"
+macro.author = "\\b{Author:}"
+macro.BR.HTML = "<br />"
+macro.copyright.HTML = "&copy;"
+macro.eacute.HTML = "&eacute;"
+macro.gui = "\\b"
+macro.HR.HTML = "<hr />"
+macro.iacute.HTML = "&iacute;"
+macro.key = "\\b"
+macro.macos = "macOS"
+macro.menu = "\\b"
+macro.oslash.HTML = "&oslash;"
+macro.ouml.HTML = "&ouml;"
+macro.nullptr = "\\c{nullptr}"
+macro.QA = "\\e{Qt Assistant}"
+macro.QD = "\\e{Qt Designer}"
+macro.QL = "\\e{Qt Linguist}"
+macro.Q_OBJECT = "Q_OBJECT"
+macro.QQV = "\\e{Qt QML Viewer}"
+macro.QtVersion = "$QT_VERSION"
+macro.QtVer = "$QT_VER"
+macro.param = "\\e"
+macro.raisedaster.HTML = "<sup>*</sup>"
+macro.raisedaster.DocBook = "\\sup{*}"
+macro.rarrow.HTML = "&rarr;"
+macro.reg.HTML = "<sup>&reg;</sup>"
+macro.rego.DocBook = "\\sup{&#174;}"
+macro.return = "Returns"
+macro.starslash = "\\c{*/}"
+macro.begincomment = "\\c{/*}"
+macro.endcomment = "\\c{*/}"
+macro.uuml.HTML = "&uuml;"
+macro.mdash.HTML = "&mdash;"
+macro.pi.HTML = "&Pi;"
+macro.beginqdoc.HTML = "/*!"
+macro.endqdoc.HTML = "*/"
macro.borderedimage = "\\div {class=\"border\"} \\image \1\n\\enddiv"
macro.beginfloatleft.HTML = "<div style=\"float: left; margin-right: 2em\">"
diff --git a/doc/global/qt-module-defaults-online.qdocconf b/doc/global/qt-module-defaults-online.qdocconf
index f2e897db65..41fb8acc66 100644
--- a/doc/global/qt-module-defaults-online.qdocconf
+++ b/doc/global/qt-module-defaults-online.qdocconf
@@ -5,7 +5,7 @@
HTML.footer = \
" </div>\n" \
" <p class=\"copy-notice\">\n" \
- " <acronym title=\"Copyright\">&copy;</acronym> 2019 The Qt Company Ltd.\n" \
+ " <acronym title=\"Copyright\">&copy;</acronym> 2020 The Qt Company Ltd.\n" \
" Documentation contributions included herein are the copyrights of\n" \
" their respective owners. " \
" The documentation provided herein is licensed under the terms of the" \