summaryrefslogtreecommitdiff
path: root/src/lib/ecore_audio
diff options
context:
space:
mode:
authorDaniel Willmann <d.willmann@samsung.com>2013-05-01 18:20:12 +0100
committerDaniel Willmann <d.willmann@samsung.com>2013-05-01 18:20:12 +0100
commit37c400eb6bb26bf5e3819900f9843817c68b3168 (patch)
tree5c36a5c64e3ef756d2459a0c9046093d09c7143a /src/lib/ecore_audio
parentf8c7f96e0557965e93e1066cb3ef573923b21cfe (diff)
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 <d.willmann@samsung.com>
Diffstat (limited to 'src/lib/ecore_audio')
-rw-r--r--src/lib/ecore_audio/Ecore_Audio.h6
-rw-r--r--src/lib/ecore_audio/ecore_audio_obj_in_sndfile.h12
-rw-r--r--src/lib/ecore_audio/ecore_audio_obj_in_tone.h17
-rw-r--r--src/lib/ecore_audio/ecore_audio_obj_out_pulse.h12
-rw-r--r--src/lib/ecore_audio/ecore_audio_obj_out_sndfile.h12
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 af1388e635..e97706032f 100644
--- a/src/lib/ecore_audio/Ecore_Audio.h
+++ b/src/lib/ecore_audio/Ecore_Audio.h
@@ -32,12 +32,6 @@ extern "C"
32 * @defgroup Ecore_Audio_Group Ecore_Audio - Convenience audio API 32 * @defgroup Ecore_Audio_Group Ecore_Audio - Convenience audio API
33 * @ingroup Ecore 33 * @ingroup Ecore
34 34
35 @section Classes
36 Ecore_Audio provides the following Eo classes:
37 @li @ref ecore_audio_obj
38 @li @ref ecore_audio_obj_in
39 @li @ref ecore_audio_obj_out
40
41 * @since 1.8 35 * @since 1.8
42 * 36 *
43 * @{ 37 * @{
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 98a56ca66c..9ed5e7d209 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 @@
20 20
21/** 21/**
22 * @file ecore_audio_obj_in_sndfile.h 22 * @file ecore_audio_obj_in_sndfile.h
23 * @brief Audio Module 23 * @brief Ecore_Audio sndfile input
24 */ 24 */
25 25
26#ifdef __cplusplus 26#ifdef __cplusplus
@@ -29,12 +29,18 @@ extern "C"
29#endif 29#endif
30 30
31/** 31/**
32 * @addtogroup Ecore_Audio_Group 32 * @defgroup ecore_audio_obj_in_sndfile - Ecore_Audio sndfile input
33 * @ingroup Ecore_Audio_Group
33 * @{ 34 * @{
34 */ 35 */
35 36
36#define ECORE_AUDIO_OBJ_IN_SNDFILE_CLASS ecore_audio_obj_in_sndfile_class_get() 37#define ECORE_AUDIO_OBJ_IN_SNDFILE_CLASS ecore_audio_obj_in_sndfile_class_get() /**< Ecore_Audio sndfile input */
37 38
39/**
40 * @brief Get the Eo class ID
41 *
42 * @return The Eo class ID
43 */
38const Eo_Class *ecore_audio_obj_in_sndfile_class_get() EINA_CONST; 44const Eo_Class *ecore_audio_obj_in_sndfile_class_get() EINA_CONST;
39 45
40extern EAPI Eo_Op ECORE_AUDIO_OBJ_IN_SNDFILE_BASE_ID; 46extern 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 7faa0db5d6..13bd01645c 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 @@
20 20
21/** 21/**
22 * @file ecore_audio_obj_in_tone.h 22 * @file ecore_audio_obj_in_tone.h
23 * @brief Audio Module 23 * @brief Ecore_Audio tone input
24 */ 24 */
25 25
26#ifdef __cplusplus 26#ifdef __cplusplus
@@ -29,14 +29,25 @@ extern "C"
29#endif 29#endif
30 30
31/** 31/**
32 * @addtogroup Ecore_Audio_Group 32 * @defgroup ecore_audio_obj_in_tone - Ecore_Audio tone input
33 * @ingroup Ecore_Audio_Group
33 * @{ 34 * @{
34 */ 35 */
35 36
37/**
38 * @brief The frequency of the tone in Hz
39 *
40 * Set with @ref eo_base_data_set()
41 */
36#define ECORE_AUDIO_ATTR_TONE_FREQ "ecore_audio_freq" 42#define ECORE_AUDIO_ATTR_TONE_FREQ "ecore_audio_freq"
37 43
38#define ECORE_AUDIO_OBJ_IN_TONE_CLASS ecore_audio_obj_in_tone_class_get() 44#define ECORE_AUDIO_OBJ_IN_TONE_CLASS ecore_audio_obj_in_tone_class_get() /**< Ecore_Audio tone input */
39 45
46/**
47 * @brief Get the Eo class ID
48 *
49 * @return The Eo class ID
50 */
40const Eo_Class *ecore_audio_obj_in_tone_class_get() EINA_CONST; 51const Eo_Class *ecore_audio_obj_in_tone_class_get() EINA_CONST;
41 52
42extern EAPI Eo_Op ECORE_AUDIO_OBJ_IN_TONE_BASE_ID; 53extern 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 f89413b8a4..b12526cc3c 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 @@
20 20
21/** 21/**
22 * @file ecore_audio_obj_out_pulse.h 22 * @file ecore_audio_obj_out_pulse.h
23 * @brief Audio Module 23 * @brief Ecore_Audio pulseaudio output
24 */ 24 */
25 25
26#ifdef __cplusplus 26#ifdef __cplusplus
@@ -29,12 +29,18 @@ extern "C"
29#endif 29#endif
30 30
31/** 31/**
32 * @addtogroup Ecore_Audio_Group 32 * @defgroup ecore_audio_obj_out_pulse - Ecore_Audio pulseaudio output
33 * @intogroup Ecore_Audio_Group
33 * @{ 34 * @{
34 */ 35 */
35 36
36#define ECORE_AUDIO_OBJ_OUT_PULSE_CLASS ecore_audio_obj_out_pulse_class_get() 37#define ECORE_AUDIO_OBJ_OUT_PULSE_CLASS ecore_audio_obj_out_pulse_class_get() /**< Ecore_Audio pulseaudio output */
37 38
39/**
40 * @brief Get the Eo class ID
41 *
42 * @return The Eo class ID
43 */
38const Eo_Class *ecore_audio_obj_out_pulse_class_get() EINA_CONST; 44const Eo_Class *ecore_audio_obj_out_pulse_class_get() EINA_CONST;
39 45
40extern EAPI Eo_Op ECORE_AUDIO_OBJ_OUT_PULSE_BASE_ID; 46extern 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 faea33cb0c..818abbe646 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 @@
20 20
21/** 21/**
22 * @file ecore_audio_obj_out_sndfile.h 22 * @file ecore_audio_obj_out_sndfile.h
23 * @brief Audio Module 23 * @brief Ecore_Audio sndfile output
24 */ 24 */
25 25
26#ifdef __cplusplus 26#ifdef __cplusplus
@@ -29,12 +29,18 @@ extern "C"
29#endif 29#endif
30 30
31/** 31/**
32 * @addtogroup Ecore_Audio_Group 32 * @defgroup ecore_audio_obj_out_sndfile - Ecore_Audio sndfile output
33 * @ingroup Ecore_Audio_Group
33 * @{ 34 * @{
34 */ 35 */
35 36
36#define ECORE_AUDIO_OBJ_OUT_SNDFILE_CLASS ecore_audio_obj_out_sndfile_class_get() 37#define ECORE_AUDIO_OBJ_OUT_SNDFILE_CLASS ecore_audio_obj_out_sndfile_class_get() /**< Ecore_Audio sndfile output */
37 38
39/**
40 * @brief Get the Eo class ID
41 *
42 * @return The Eo class ID
43 */
38const Eo_Class *ecore_audio_obj_out_sndfile_class_get() EINA_CONST; 44const Eo_Class *ecore_audio_obj_out_sndfile_class_get() EINA_CONST;
39 45
40extern EAPI Eo_Op ECORE_AUDIO_OBJ_OUT_SNDFILE_BASE_ID; 46extern EAPI Eo_Op ECORE_AUDIO_OBJ_OUT_SNDFILE_BASE_ID;