BlackBerry: Improve platform specific documentation

Updated BlackBerry specific documentation around QSettings to make the
differences more obvious for developers.

Change-Id: Ib9acc2409379a836713f1a7e9d6189585a35aa61
Reviewed-by: Kevin Krammer <kevin.krammer@kdab.com>
Reviewed-by: Erin Rahnenfuehrer <erahnenfuehrer@blackberry.com>
Reviewed-by: Rafael Roquetto <rafael.roquetto@kdab.com>
Reviewed-by: Fabian Bumberger <fbumberger@rim.com>

2 files changed, 20 insertions, 2 deletions

diff --git a/src/corelib/io/qsettings.cpp b/src/corelib/io/qsettings.cpp
index a3727a6a4b..0406aeb501 100644
--- a/src/corelib/io/qsettings.cpp
+++ b/src/corelib/io/qsettings.cpp
@@ -2369,6 +2369,10 @@ void QConfFileSettingsPrivate::ensureSectionParsed(QConfFile *confFile,
     stored in the following registry path:
     \c{HKEY_LOCAL_MACHINE\Software\WOW6432node}.
 
+    On BlackBerry only a single file is used (see \l{Platform Limitations}).
+    If the file format is NativeFormat, this is "Settings/MySoft/Star Runner.conf"
+    in the application's home directory.
+
     If the file format is IniFormat, the following files are
     used on Unix and Mac OS X:
 
@@ -2393,8 +2397,12 @@ void QConfFileSettingsPrivate::ensureSectionParsed(QConfFile *confFile,
     %COMMON_APPDATA% path is usually \tt{C:\\Documents and
     Settings\\All Users\\Application Data}.
 
+    On BlackBerry only a single file is used (see \l{Platform Limitations}).
+    If the file format is IniFormat, this is "Settings/MySoft/Star Runner.ini"
+    in the application's home directory.
+
     The paths for the \c .ini and \c .conf files can be changed using
-    setPath(). On Unix and Mac OS X, the user can override them by by
+    setPath(). On Unix and Mac OS X, the user can override them by
     setting the \c XDG_CONFIG_HOME environment variable; see
     setPath() for details.
 
@@ -2498,7 +2506,8 @@ void QConfFileSettingsPrivate::ensureSectionParsed(QConfFile *confFile,
        allowed to read or write outside of this sandbox. This involves the
        following limitations:
        \list
-       \li As there is only a single scope the scope is simply ignored.
+       \li As there is only a single scope the scope is simply ignored,
+           i.e. there is no difference between SystemScope and UserScope.
        \li The \l{Fallback Mechanism} is not applied, i.e. only a single
           location is considered.
        \li It is advised against setting and using custom file paths.
diff --git a/src/corelib/kernel/qcoreapplication.cpp b/src/corelib/kernel/qcoreapplication.cpp
index e8bcc449e9..bb2feee71e 100644
--- a/src/corelib/kernel/qcoreapplication.cpp
+++ b/src/corelib/kernel/qcoreapplication.cpp
@@ -2217,6 +2217,9 @@ QStringList QCoreApplication::arguments()
     organizationName(). On all other platforms, QSettings uses
     organizationName() as the organization.
 
+    On BlackBerry this property is read-only. It is obtained from the
+    BAR application descriptor file.
+
     \sa organizationDomain, applicationName
 */
 
@@ -2294,6 +2297,9 @@ QString QCoreApplication::organizationDomain()
 
     If not set, the application name defaults to the executable name (since 5.0).
 
+    On BlackBerry this property is read-only. It is obtained from the
+    BAR application descriptor file.
+
     \sa organizationName, organizationDomain, applicationVersion, applicationFilePath()
 */
 /*!
@@ -2335,6 +2341,9 @@ Q_CORE_EXPORT QString qt_applicationName_noFallback()
     \since 4.4
     \brief the version of this application
 
+    On BlackBerry this property is read-only. It is obtained from the
+    BAR application descriptor file.
+
     \sa applicationName, organizationName, organizationDomain
 */
 /*!