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>

diff --git a/src/corelib/io/qstandardpaths.cpp b/src/corelib/io/qstandardpaths.cpp
index 700b80b..6e66f8b 100644 (file)
--- 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()
  */
 
 /*!