asdfuser pushed a commit to branch master.
commit 37c400eb6bb26bf5e3819900f9843817c68b3168
Author: Daniel Willmann <[email protected]>
Date: Wed May 1 18:20:12 2013 +0100
ecore_audio: Document the remaining in-/outputs
Also remove the Classes section from the Ecore_Audio_Group, we don't
need it as the pages are linked automatically
Signed-off-by: Daniel Willmann <[email protected]>
---
src/lib/ecore_audio/Ecore_Audio.h | 6 ------
src/lib/ecore_audio/ecore_audio_obj_in_sndfile.h | 12 +++++++++---
src/lib/ecore_audio/ecore_audio_obj_in_tone.h | 17 ++++++++++++++---
src/lib/ecore_audio/ecore_audio_obj_out_pulse.h | 12 +++++++++---
src/lib/ecore_audio/ecore_audio_obj_out_sndfile.h | 12 +++++++++---
5 files changed, 41 insertions(+), 18 deletions(-)
diff --git a/src/lib/ecore_audio/Ecore_Audio.h
b/src/lib/ecore_audio/Ecore_Audio.h
index af1388e..e977060 100644
--- a/src/lib/ecore_audio/Ecore_Audio.h
+++ b/src/lib/ecore_audio/Ecore_Audio.h
@@ -32,12 +32,6 @@ extern "C"
* @defgroup Ecore_Audio_Group Ecore_Audio - Convenience audio API
* @ingroup Ecore
- @section Classes
- Ecore_Audio provides the following Eo classes:
- @li @ref ecore_audio_obj
- @li @ref ecore_audio_obj_in
- @li @ref ecore_audio_obj_out
-
* @since 1.8
*
* @{
diff --git a/src/lib/ecore_audio/ecore_audio_obj_in_sndfile.h
b/src/lib/ecore_audio/ecore_audio_obj_in_sndfile.h
index 98a56ca..9ed5e7d 100644
--- a/src/lib/ecore_audio/ecore_audio_obj_in_sndfile.h
+++ b/src/lib/ecore_audio/ecore_audio_obj_in_sndfile.h
@@ -20,7 +20,7 @@
/**
* @file ecore_audio_obj_in_sndfile.h
- * @brief Audio Module
+ * @brief Ecore_Audio sndfile input
*/
#ifdef __cplusplus
@@ -29,12 +29,18 @@ extern "C"
#endif
/**
- * @addtogroup Ecore_Audio_Group
+ * @defgroup ecore_audio_obj_in_sndfile - Ecore_Audio sndfile input
+ * @ingroup Ecore_Audio_Group
* @{
*/
-#define ECORE_AUDIO_OBJ_IN_SNDFILE_CLASS ecore_audio_obj_in_sndfile_class_get()
+#define ECORE_AUDIO_OBJ_IN_SNDFILE_CLASS
ecore_audio_obj_in_sndfile_class_get() /**< Ecore_Audio sndfile input */
+/**
+ * @brief Get the Eo class ID
+ *
+ * @return The Eo class ID
+ */
const Eo_Class *ecore_audio_obj_in_sndfile_class_get() EINA_CONST;
extern EAPI Eo_Op ECORE_AUDIO_OBJ_IN_SNDFILE_BASE_ID;
diff --git a/src/lib/ecore_audio/ecore_audio_obj_in_tone.h
b/src/lib/ecore_audio/ecore_audio_obj_in_tone.h
index 7faa0db..13bd016 100644
--- a/src/lib/ecore_audio/ecore_audio_obj_in_tone.h
+++ b/src/lib/ecore_audio/ecore_audio_obj_in_tone.h
@@ -20,7 +20,7 @@
/**
* @file ecore_audio_obj_in_tone.h
- * @brief Audio Module
+ * @brief Ecore_Audio tone input
*/
#ifdef __cplusplus
@@ -29,14 +29,25 @@ extern "C"
#endif
/**
- * @addtogroup Ecore_Audio_Group
+ * @defgroup ecore_audio_obj_in_tone - Ecore_Audio tone input
+ * @ingroup Ecore_Audio_Group
* @{
*/
+/**
+ * @brief The frequency of the tone in Hz
+ *
+ * Set with @ref eo_base_data_set()
+ */
#define ECORE_AUDIO_ATTR_TONE_FREQ "ecore_audio_freq"
-#define ECORE_AUDIO_OBJ_IN_TONE_CLASS ecore_audio_obj_in_tone_class_get()
+#define ECORE_AUDIO_OBJ_IN_TONE_CLASS ecore_audio_obj_in_tone_class_get() /**<
Ecore_Audio tone input */
+/**
+ * @brief Get the Eo class ID
+ *
+ * @return The Eo class ID
+ */
const Eo_Class *ecore_audio_obj_in_tone_class_get() EINA_CONST;
extern EAPI Eo_Op ECORE_AUDIO_OBJ_IN_TONE_BASE_ID;
diff --git a/src/lib/ecore_audio/ecore_audio_obj_out_pulse.h
b/src/lib/ecore_audio/ecore_audio_obj_out_pulse.h
index f89413b..b12526c 100644
--- a/src/lib/ecore_audio/ecore_audio_obj_out_pulse.h
+++ b/src/lib/ecore_audio/ecore_audio_obj_out_pulse.h
@@ -20,7 +20,7 @@
/**
* @file ecore_audio_obj_out_pulse.h
- * @brief Audio Module
+ * @brief Ecore_Audio pulseaudio output
*/
#ifdef __cplusplus
@@ -29,12 +29,18 @@ extern "C"
#endif
/**
- * @addtogroup Ecore_Audio_Group
+ * @defgroup ecore_audio_obj_out_pulse - Ecore_Audio pulseaudio output
+ * @intogroup Ecore_Audio_Group
* @{
*/
-#define ECORE_AUDIO_OBJ_OUT_PULSE_CLASS ecore_audio_obj_out_pulse_class_get()
+#define ECORE_AUDIO_OBJ_OUT_PULSE_CLASS ecore_audio_obj_out_pulse_class_get()
/**< Ecore_Audio pulseaudio output */
+/**
+ * @brief Get the Eo class ID
+ *
+ * @return The Eo class ID
+ */
const Eo_Class *ecore_audio_obj_out_pulse_class_get() EINA_CONST;
extern EAPI Eo_Op ECORE_AUDIO_OBJ_OUT_PULSE_BASE_ID;
diff --git a/src/lib/ecore_audio/ecore_audio_obj_out_sndfile.h
b/src/lib/ecore_audio/ecore_audio_obj_out_sndfile.h
index faea33c..818abbe 100644
--- a/src/lib/ecore_audio/ecore_audio_obj_out_sndfile.h
+++ b/src/lib/ecore_audio/ecore_audio_obj_out_sndfile.h
@@ -20,7 +20,7 @@
/**
* @file ecore_audio_obj_out_sndfile.h
- * @brief Audio Module
+ * @brief Ecore_Audio sndfile output
*/
#ifdef __cplusplus
@@ -29,12 +29,18 @@ extern "C"
#endif
/**
- * @addtogroup Ecore_Audio_Group
+ * @defgroup ecore_audio_obj_out_sndfile - Ecore_Audio sndfile output
+ * @ingroup Ecore_Audio_Group
* @{
*/
-#define ECORE_AUDIO_OBJ_OUT_SNDFILE_CLASS
ecore_audio_obj_out_sndfile_class_get()
+#define ECORE_AUDIO_OBJ_OUT_SNDFILE_CLASS
ecore_audio_obj_out_sndfile_class_get() /**< Ecore_Audio sndfile output */
+/**
+ * @brief Get the Eo class ID
+ *
+ * @return The Eo class ID
+ */
const Eo_Class *ecore_audio_obj_out_sndfile_class_get() EINA_CONST;
extern EAPI Eo_Op ECORE_AUDIO_OBJ_OUT_SNDFILE_BASE_ID;
--
------------------------------------------------------------------------------
Introducing AppDynamics Lite, a free troubleshooting tool for Java/.NET
Get 100% visibility into your production application - at no cost.
Code-level diagnostics for performance bottlenecks with <2% overhead
Download for free and get started troubleshooting in minutes.
http://p.sf.net/sfu/appdyn_d2d_ap1
