Added documentation for audioProtpertiesChanged signal

2 files changed, 10 insertions, 1 deletions

diff --git a/libresourceqt/Doxyfile b/libresourceqt/Doxyfile
index 3918664..f493c9a 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.17
+PROJECT_NUMBER         = 1.21
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
 # base path where the generated documentation will be put. 
diff --git a/libresourceqt/include/qt4/policy/audio-resource.h b/libresourceqt/include/qt4/policy/audio-resource.h
index 27ffac6..87f215f 100644
--- a/libresourceqt/include/qt4/policy/audio-resource.h
+++ b/libresourceqt/include/qt4/policy/audio-resource.h
@@ -87,6 +87,15 @@ private:
     QString streamName;
     QString streamValue;
 signals:
+    /**
+     * This signal is emitted when any of the properties of the AudioResource
+     * 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 name The new Stream tag name
+     * \param value the new stream tag value
+     */
     void audioPropertiesChanged(const QString &group, quint32 pid,
                                 const QString &name, const QString &value);
 };