From 2a13b037defdade8844ea65b4805ea08b8788f0b Mon Sep 17 00:00:00 2001
From: Wolf Bergenheim <ext-wolf.2.bergenheim@nokia.com>
Date: Wed, 20 Oct 2010 12:41:03 +0300
Subject: Updated documentation

---
 libresourceqt/include/qt4/policy/audio-resource.h |  2 +-
 libresourceqt/include/qt4/policy/resource-set.h   | 12 ++++++------
 libresourceqt/include/qt4/policy/resource.h       | 14 ++++++++++++++
 3 files changed, 21 insertions(+), 7 deletions(-)

diff --git a/libresourceqt/include/qt4/policy/audio-resource.h b/libresourceqt/include/qt4/policy/audio-resource.h
index 87f215f..c0874fa 100644
--- a/libresourceqt/include/qt4/policy/audio-resource.h
+++ b/libresourceqt/include/qt4/policy/audio-resource.h
@@ -92,7 +92,7 @@ signals:
      * are changed. This signal is connected to in the ResourceSet to
      * track the changes to the AudioResource object.
      * \param group The new audio group
-     * \param pit The new PID of the audio renderer
+     * \param pid The new PID of the audio renderer
      * \param name The new Stream tag name
      * \param value the new stream tag value
      */
diff --git a/libresourceqt/include/qt4/policy/resource-set.h b/libresourceqt/include/qt4/policy/resource-set.h
index 7414a40..bd23e62 100644
--- a/libresourceqt/include/qt4/policy/resource-set.h
+++ b/libresourceqt/include/qt4/policy/resource-set.h
@@ -98,13 +98,14 @@ class ResourceSet: public QObject
     Q_DISABLE_COPY(ResourceSet)
 public:
     /**
-     * The constructor.
+     * Alternative constructor with additional parameters for setting
+     * alwaysReply and autoRelease.
      * \param applicationClass This parameter defines the application class.
      * The application class is used to determine the priority order of the
      * application.
-     * \param parent The optional parent of of this class.
-     * \param alwaysReply Set this to true to always get a reply from the
-     * Resource Manager. This optional parameter defaults to false.
+     * \param parent The parent of this class.
+     * \param alwaysReply see setAlwaysReply()
+     * \param autoRelease see setAutoRelease()
      */
     ResourceSet(const QString &applicationClass, QObject *parent,
                 bool alwaysReply, bool autoRelease);
@@ -148,8 +149,7 @@ public:
     /**
      * This method returns a list of all resource in the set.
      * \return a QList of all resources in the set.
-     */
-    QList<Resource *> resources() const;
+     */    QList<Resource *> resources() const;
     /**
      * This method returns a const pointer to a resource of a specific type.
      * \param type The type of resource we are interested in.
diff --git a/libresourceqt/include/qt4/policy/resource.h b/libresourceqt/include/qt4/policy/resource.h
index 1748a92..f77ac31 100644
--- a/libresourceqt/include/qt4/policy/resource.h
+++ b/libresourceqt/include/qt4/policy/resource.h
@@ -88,8 +88,22 @@ protected:
     Resource();
     Resource(const Resource &other);
 
+    /**
+     * \internal
+     * This holds the type of the resource.
+     */
     ResourceType resourceType;
+    /**
+     * \internal
+     * This is true when this resource is optional.
+     * \sa isOptional
+     * \sa setOptional
+     */
     bool optional;
+    /**
+     * \internal
+     * This is just a unique identifier for the resource.
+     */
     quint32 identifier;
 private:
     void setGranted();
-- 
cgit v1.2.3