BlackBerry: Improve platform specific documentation

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

Back-ported from qtbase: 563342d7ef7e490239cba6d335849ebb91983b9a

Change-Id: I603053cecff97f3222257cbba8d72d2ec2666d6f
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 51db081f04..f0f901ed0c 100644
--- a/src/corelib/io/qsettings.cpp
+++ b/src/corelib/io/qsettings.cpp
@@ -2319,6 +2319,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:
 
@@ -2343,6 +2347,10 @@ 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.
+
     On Symbian, the following files are used for both IniFormat and
     NativeFormat (in this example, we assume that the application is
     installed on the \c e-drive and its Secure ID is \c{0xECB00931}):
@@ -2363,7 +2371,7 @@ void QConfFileSettingsPrivate::ensureSectionParsed(QConfFile *confFile,
     environments.
 
     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.
 
@@ -2514,7 +2522,8 @@ void QConfFileSettingsPrivate::ensureSectionParsed(QConfFile *confFile,
        allowed to read or write outside of this sandbox. This involves the
        following limitations:
        \list
-       \o As there is only a single scope the scope is simply ignored.
+       \o As there is only a single scope the scope is simply ignored,
+          i.e. there is no difference between SystemScope and UserScope.
        \o The \l{Fallback Mechanism} is not applied, i.e. only a single
           location is considered.
        \o 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 8c9e3f87c5..1b910ec543 100644
--- a/src/corelib/kernel/qcoreapplication.cpp
+++ b/src/corelib/kernel/qcoreapplication.cpp
@@ -2360,6 +2360,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
 */
 
@@ -2409,6 +2412,9 @@ QString QCoreApplication::organizationDomain()
     using the empty constructor. This saves having to repeat this
     information each time a QSettings object is created.
 
+    On BlackBerry this property is read-only. It is obtained from the
+    BAR application descriptor file.
+
     \sa organizationName organizationDomain applicationVersion
 */
 void QCoreApplication::setApplicationName(const QString &application)
@@ -2434,6 +2440,9 @@ QString QCoreApplication::applicationName()
     \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
 */
 void QCoreApplication::setApplicationVersion(const QString &version)