summaryrefslogtreecommitdiffstats
path: root/src/corelib
diff options
context:
space:
mode:
authorJeremy Katz <jeremy.katz@nokia.com>2012-06-07 14:13:14 +0200
committerQt by Nokia <qt-info@nokia.com>2012-06-11 00:37:12 +0200
commit69f0782c0975d34c94d45e8162dfc77275e0b21d (patch)
treea169c96b31826170c9c318d6851a527ee5566b9b /src/corelib
parent7616f310521a24b4741e8ab0cb85bff6ebeee817 (diff)
update QStandardPaths::standardLocations() documentation
Remove the reference to PATH, as it may confuse developers who expect a separator between locations. The ordering has been made explicit, including the position of writableLocation() if it can be determined. Note that some implementations may allow the empty string. Change-Id: I134db44dd8bea437824a1d0bf8ed373ec655ab04 Reviewed-by: David Faure <faure@kde.org>
Diffstat (limited to 'src/corelib')
-rw-r--r--src/corelib/io/qstandardpaths.cpp7
1 files changed, 5 insertions, 2 deletions
diff --git a/src/corelib/io/qstandardpaths.cpp b/src/corelib/io/qstandardpaths.cpp
index 700b80b062..6e66f8b2cd 100644
--- a/src/corelib/io/qstandardpaths.cpp
+++ b/src/corelib/io/qstandardpaths.cpp
@@ -113,8 +113,11 @@ QT_BEGIN_NAMESPACE
Returns all the directories where files of \a type belong.
- Much like the PATH variable, it returns the directories in order of priority,
- starting with the user-specific writableLocation() for the \a type.
+ 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 \a type are defined.
+
+ \sa writableLocation()
*/
/*!