From 08812af10c43426ef521abbdc68b91f8ba9cfb62 Mon Sep 17 00:00:00 2001 From: Wolf Bergenheim Date: Wed, 20 Oct 2010 14:07:00 +0300 Subject: Updated documentation and bumped version --- libresourceqt/Doxyfile | 6 +- libresourceqt/include/qt4/policy/resource.h | 6 +- libresourceqt/include/qt4/policy/resources.h | 194 ++++++++++++++++++++++++++- libresourceqt/src/resources.cpp | 2 +- 4 files changed, 197 insertions(+), 11 deletions(-) (limited to 'libresourceqt') diff --git a/libresourceqt/Doxyfile b/libresourceqt/Doxyfile index 6f7eeee..5a3c155 100644 --- a/libresourceqt/Doxyfile +++ b/libresourceqt/Doxyfile @@ -31,7 +31,7 @@ PROJECT_NAME = ResourcePolicy # This could be handy for archiving the generated documentation or # if some version control system is used. -PROJECT_NUMBER = 1.21 +PROJECT_NUMBER = 1.24 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) # base path where the generated documentation will be put. @@ -108,7 +108,7 @@ ALWAYS_DETAILED_SEC = NO # members were ordinary class members. Constructors, destructors and assignment # operators of the base classes will not be shown. -INLINE_INHERITED_MEMB = NO +INLINE_INHERITED_MEMB = YES # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full # path before files name in the file list and in the header files. If set @@ -955,7 +955,7 @@ ENUM_VALUES_PER_LINE = 1 # releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE # respectively. -GENERATE_TREEVIEW = HIERARCHIES +GENERATE_TREEVIEW = NO # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be # used to set the initial width (in pixels) of the frame in which the tree diff --git a/libresourceqt/include/qt4/policy/resource.h b/libresourceqt/include/qt4/policy/resource.h index f77ac31..7a54ab9 100644 --- a/libresourceqt/include/qt4/policy/resource.h +++ b/libresourceqt/include/qt4/policy/resource.h @@ -51,9 +51,9 @@ enum ResourceType { 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. -*/ + * This class is the super class for all resources. It represents a generic + * \ref Resource. The type specific resource classes should be used. + */ class Resource { friend class ResourceSet; diff --git a/libresourceqt/include/qt4/policy/resources.h b/libresourceqt/include/qt4/policy/resources.h index cf5efa3..d8c2e5e 100644 --- a/libresourceqt/include/qt4/policy/resources.h +++ b/libresourceqt/include/qt4/policy/resources.h @@ -28,127 +28,313 @@ USA. namespace ResourcePolicy { +/** + * The AudioRecorderResource class represents the audio recorder device. + */ class AudioRecorderResource: public Resource { public: + /** + * The constructor. + */ AudioRecorderResource(); + /** + * The copy constructor. + * \param other The resource to copy from + */ AudioRecorderResource(const AudioRecorderResource &other); + /** + * The destructor. + */ virtual ~AudioRecorderResource(); + /** + * \return the resource type + */ virtual ResourceType type() const; -private: - QString group; - quint32 pid; - QString stream; }; +/** + * The BacklightResource is used by applications wanting to control the + * backlight + */ class BacklightResource: public Resource { public: + /** + * The constructor. + */ BacklightResource(); + /** + * The copy constructor. + * \param other The resource to copy from + */ BacklightResource(const BacklightResource &other); + /** + * The destructor. + */ virtual ~BacklightResource(); + /** + * \return the resource type + */ virtual ResourceType type() const; }; +/** + * Resource to be used when the application wants to fiddle with the leds. + */ class LedsResource: public Resource { public: + /** + * The constructor. + */ LedsResource(); + /** + * The copy constructor. + * \param other The resource to copy from + */ LedsResource(const LedsResource &other); + /** + * The destructor. + */ virtual ~LedsResource(); + /** + * \return the resource type + */ virtual ResourceType type() const; }; +/** + * Resource to be used when the application wants to use the vibra. + */ class VibraResource: public Resource { public: + /** + * The constructor. + */ VibraResource(); + /** + * The copy constructor. + * \param other The resource to copy from + */ VibraResource(const VibraResource &other); + /** + * The destructor. + */ virtual ~VibraResource(); + /** + * \return the resource type + */ virtual ResourceType type() const; }; +/** + * Resource to be used when the application wants to record video. + */ class VideoRecorderResource: public Resource { public: + /** + * The constructor. + */ VideoRecorderResource(); + /** + * The copy constructor. + * \param other The resource to copy from + */ VideoRecorderResource(const VideoRecorderResource &other); + /** + * The destructor. + */ virtual ~VideoRecorderResource(); + /** + * \return the resource type + */ virtual ResourceType type() const; }; +/** + * Resource to be used when the application wants to render video with the + * DSP decoder to render the viewfinder. + */ class VideoResource: public Resource { public: + /** + * The constructor. + */ VideoResource(); + /** + * The copy constructor. + * \param other The resource to copy from + */ VideoResource(const VideoResource &other); + /** + * The destructor. + */ virtual ~VideoResource(); + /** + * \return the resource type + */ virtual ResourceType type() const; }; +/** + * Resource to be used when the application wants to control the system button. + */ class SystemButtonResource: public Resource { public: + /** + * The constructor. + */ SystemButtonResource(); + /** + * The copy constructor. + * \param other The resource to copy from + */ SystemButtonResource(const SystemButtonResource &other); + /** + * The destructor. + */ virtual ~SystemButtonResource(); + /** + * \return the resource type + */ virtual ResourceType type() const; }; class LockButtonResource: public Resource { public: + /** + * The constructor. + */ LockButtonResource(); + /** + * The copy constructor. + * \param other The resource to copy from + */ LockButtonResource(const LockButtonResource &other); + /** + * The destructor. + */ virtual ~LockButtonResource(); + /** + * \return the resource type + */ virtual ResourceType type() const; }; +/** + * Resource to be used when the application wants to control + * the volume/scale button. + */ class ScaleButtonResource: public Resource { public: + /** + * The constructor. + */ ScaleButtonResource(); + /** + * The copy constructor. + * \param other The resource to copy from + */ ScaleButtonResource(const ScaleButtonResource &other); + /** + * The destructor. + */ virtual ~ScaleButtonResource(); + /** + * \return the resource type + */ virtual ResourceType type() const; }; +/** + * Resource to be used when the application wants to take still pictures. + */ class SnapButtonResource: public Resource { public: + /** + * The constructor. + */ SnapButtonResource(); + /** + * The copy constructor. + * \param other The resource to copy from + */ SnapButtonResource(const SnapButtonResource &other); + /** + * The destructor. + */ virtual ~SnapButtonResource(); + /** + * \return the resource type + */ virtual ResourceType type() const; }; class LensCoverResource: public Resource { public: + /** + * The constructor. + */ LensCoverResource(); + /** + * The copy constructor. + * \param other The resource to copy from + */ LensCoverResource(const LensCoverResource &other); + /** + * The destructor. + */ virtual ~LensCoverResource(); + /** + * \return the resource type + */ virtual ResourceType type() const; }; +/** + * Resource to be used when the application wants to control the + * headset buttons. + */ class HeadsetButtonsResource: public Resource { public: + /** + * The constructor. + */ HeadsetButtonsResource(); + /** + * The copy constructor. + * \param other The resource to copy from + */ HeadsetButtonsResource(const HeadsetButtonsResource &other); + /** + * The destructor. + */ virtual ~HeadsetButtonsResource(); + /** + * \return the resource type + */ virtual ResourceType type() const; }; diff --git a/libresourceqt/src/resources.cpp b/libresourceqt/src/resources.cpp index 2376984..bdb9e2a 100644 --- a/libresourceqt/src/resources.cpp +++ b/libresourceqt/src/resources.cpp @@ -29,7 +29,7 @@ AudioRecorderResource::AudioRecorderResource() } AudioRecorderResource::AudioRecorderResource(const AudioRecorderResource &other) - : Resource(other), group(other.group), pid(other.pid), stream(other.stream) + : Resource(other) { } -- cgit v1.2.3