[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-commits
Subject:    KDE/kdelibs/kdecore/config
From:       Alex Merry <kde () randomguy3 ! me ! uk>
Date:       2008-08-11 19:57:19
Message-ID: 1218484639.414069.23863.nullmailer () svn ! kde ! org
[Download RAW message or body]

SVN commit 845480 by alexmerry:

Update the api documentation.



 M  +21 -11    kdesktopfile.h  


--- trunk/KDE/kdelibs/kdecore/config/kdesktopfile.h #845479:845480
@@ -39,21 +39,31 @@
 {
 public:
   /**
-   * Constructs a KDesktopFile object and make it either read-write
-   * or read-only.
+   * Constructs a KDesktopFile object.
    *
-   * @param fileName  The name or path of the desktop file. If it
-   *                  is not absolute, it will be located
-   *                  using the resource type @p resType.
-   * @param readOnly  Whether the object should be read-only.
-   * @param resType   Allows you to change what sort of resource
-   *                  to search for if @p fileName is not absolute.  For
-   *                  instance, you might want to specify "config".
+   * See KStandardDirs for more information on resources.
+   *
+   * @param resourceType   Allows you to change what sort of resource
+   *                       to search for if @p fileName is not absolute.
+   *                       For instance, you might want to specify "config".
+   * @param fileName       The name or path of the desktop file. If it
+   *                       is not absolute, it will be located
+   *                       using the resource type @p resType.
    */
-  explicit KDesktopFile( const char * resourceType, const QString &fileName);
-  explicit KDesktopFile( const QString& fileName);
+  explicit KDesktopFile(const char *resourceType, const QString &fileName);
 
   /**
+   * Constructs a KDesktopFile object.
+   *
+   * See KStandardDirs for more information on resources.
+   *
+   * @param fileName       The name or path of the desktop file. If it
+   *                       is not absolute, it will be located
+   *                       using the resource type "apps"
+   */
+  explicit KDesktopFile(const QString &fileName);
+
+  /**
    * Destructs the KDesktopFile object.
    *
    * Writes back any dirty configuration entries.
[prev in list] [next in list] [prev in thread] [next in thread]