From ff1e1a228971c2412ad21693e558bbdcaaeaba77 Mon Sep 17 00:00:00 2001
From: Wolf Bergenheim <ext-wolf.2.bergenheim@nokia.com>
Date: Wed, 10 Mar 2010 14:32:07 +0200
Subject: Updated documentation

---
 libresourceqt/include/qt4/policy/resource.h | 34 +++++++++++++++++------------
 1 file changed, 20 insertions(+), 14 deletions(-)

(limited to 'libresourceqt/include/qt4/policy/resource.h')

diff --git a/libresourceqt/include/qt4/policy/resource.h b/libresourceqt/include/qt4/policy/resource.h
index 434f3dd..4c18408 100644
--- a/libresourceqt/include/qt4/policy/resource.h
+++ b/libresourceqt/include/qt4/policy/resource.h
@@ -5,24 +5,27 @@
 
 namespace ResourcePolicy
 {
+/**
+  * This enumeration represents the resources which can be reserved.
+  * \see ResourcePolicy::ResourceSet::AddResource() for info on how to reserve
+  * resources.
+  */
 enum ResourceType {
-    AudioPlaybackType = 0,
-    VideoPlaybackType,
-    AudioRecorderType,
-    VideoRecorderType,
-    VibraType,
-    LedsType,
-    BacklightType,
-    SystemButtonType,
-    LockButtonType,
-    ScaleButtonType,
-    SnapButtonType,
+    AudioPlaybackType = 0, ///< For audio playback
+    VideoPlaybackType,     ///< For video playback
+    AudioRecorderType,     ///< For audio recording (using of the microphone)
+    VideoRecorderType,     ///< For video recording (using the camera)
+    VibraType,             ///< For Vibra
+    LedsType,              ///< For LEDs
+    BacklightType,         ///< For the backlight (of the display)
+    SystemButtonType,      ///< For the system (power) button
+    LockButtonType,        ///< For the lock button
+    ScaleButtonType,       ///< The scale (zoom) button
+    SnapButtonType,        ///< Use this if you are a camera application
     LensCoverType,
     NumberOfTypes
 };
 
-class ResourceSet;
-
 /**
 * This class is the super class for all resources. It represents a generic
 * \ref Resource. The type specific resource classes should be used.
@@ -30,7 +33,6 @@ class ResourceSet;
 class Resource
 {
 public:
-    friend class ResourceSet;
     /**
      * Whether or not this resource is optional, in that it doesn't need to
      * be available for the set to be acquired.
@@ -51,6 +53,10 @@ public:
      */
     bool isGranted() const;
 
+    /**
+     * Use this method to check for the type of Resource
+     * \return The ResourceType associated to this resource
+     */
     virtual ResourceType type() const = 0;
     virtual ~Resource();
 protected:
-- 
cgit v1.2.3