summaryrefslogtreecommitdiff
path: root/src/lib/ecore_audio
diff options
context:
space:
mode:
authorMyoungwoon Roy, Kim <myoungwoon.kim@samsung.com>2017-02-13 15:29:11 +0900
committerJean-Philippe Andre <jp.andre@samsung.com>2017-02-13 19:54:29 +0900
commit01931c4676ba3a55ca65cd2cd3c2b3e55804c1c8 (patch)
tree024a8a9a725a97dfbd12279455dd8fa22e21458f /src/lib/ecore_audio
parente4b37d7cb41e005accf2703ec34a9002f14dc4bb (diff)
doxygen: Fix typos & invalid statements in ecore
This covers ecore audio, avahi, buffer and con. Summary: There are some typos and cacologigue statements in doxygen of ecore_audio, ecore_avahi, ecore_buffer, and ecore_con. Test Plan: API Doxygen Revision Reviewers: stefan, cedric, raster, Jaehyun_Cho Subscribers: jpeg, conr2d Differential Revision: https://phab.enlightenment.org/D4652
Diffstat (limited to 'src/lib/ecore_audio')
-rw-r--r--src/lib/ecore_audio/Ecore_Audio.h22
-rw-r--r--src/lib/ecore_audio/ecore_audio_obj.h2
-rw-r--r--src/lib/ecore_audio/ecore_audio_obj_in.h2
-rw-r--r--src/lib/ecore_audio/ecore_audio_obj_in_sndfile.h2
-rw-r--r--src/lib/ecore_audio/ecore_audio_obj_in_tone.h4
-rw-r--r--src/lib/ecore_audio/ecore_audio_obj_out.h2
-rw-r--r--src/lib/ecore_audio/ecore_audio_obj_out_pulse.h2
-rw-r--r--src/lib/ecore_audio/ecore_audio_obj_out_sndfile.h2
8 files changed, 19 insertions, 19 deletions
diff --git a/src/lib/ecore_audio/Ecore_Audio.h b/src/lib/ecore_audio/Ecore_Audio.h
index 2f18b24..af58822 100644
--- a/src/lib/ecore_audio/Ecore_Audio.h
+++ b/src/lib/ecore_audio/Ecore_Audio.h
@@ -20,7 +20,7 @@
20 20
21/** 21/**
22 * @file Ecore_Audio.h 22 * @file Ecore_Audio.h
23 * @brief Audio utility functions 23 * @brief Audio utility functions.
24 */ 24 */
25 25
26#ifdef __cplusplus 26#ifdef __cplusplus
@@ -69,7 +69,7 @@ typedef struct _Ecore_Audio_Object Ecore_Audio_Object; /**< The audio object */
69 */ 69 */
70struct _Ecore_Audio_Vio { 70struct _Ecore_Audio_Vio {
71 /** 71 /**
72 * @brief Get the length of the file 72 * @brief Gets the length of the file.
73 * 73 *
74 * @param data User data from the ecore_audio_obj_set_vio call 74 * @param data User data from the ecore_audio_obj_set_vio call
75 * @param eo_obj The Ecore_Audio object this operates on 75 * @param eo_obj The Ecore_Audio object this operates on
@@ -81,7 +81,7 @@ struct _Ecore_Audio_Vio {
81 int (*get_length)(void *data, Eo *eo_obj); 81 int (*get_length)(void *data, Eo *eo_obj);
82 82
83 /** 83 /**
84 * @brief Seek to a position within the file 84 * @brief Seeks to a position within the file.
85 * 85 *
86 * @param data User data from the ecore_audio_obj_set_vio call 86 * @param data User data from the ecore_audio_obj_set_vio call
87 * @param eo_obj The Ecore_Audio object this operates on 87 * @param eo_obj The Ecore_Audio object this operates on
@@ -99,7 +99,7 @@ struct _Ecore_Audio_Vio {
99 int (*seek)(void *data, Eo *eo_obj, int offset, int whence); 99 int (*seek)(void *data, Eo *eo_obj, int offset, int whence);
100 100
101 /** 101 /**
102 * @brief Get the current position within the file 102 * @brief Gets the current position within the file.
103 * 103 *
104 * @param data User data from the ecore_audio_obj_set_vio call 104 * @param data User data from the ecore_audio_obj_set_vio call
105 * @param eo_obj The Ecore_Audio object this operates on 105 * @param eo_obj The Ecore_Audio object this operates on
@@ -113,7 +113,7 @@ struct _Ecore_Audio_Vio {
113 int (*tell)(void *data, Eo *eo_obj); 113 int (*tell)(void *data, Eo *eo_obj);
114 114
115 /** 115 /**
116 * @brief Read some data from the file 116 * @brief Reads some data from the file.
117 * 117 *
118 * @param data User data from the ecore_audio_obj_set_vio call 118 * @param data User data from the ecore_audio_obj_set_vio call
119 * @param eo_obj The Ecore_Audio object this operates on 119 * @param eo_obj The Ecore_Audio object this operates on
@@ -127,7 +127,7 @@ struct _Ecore_Audio_Vio {
127 int (*read)(void *data, Eo *eo_obj, void *buffer, int length); 127 int (*read)(void *data, Eo *eo_obj, void *buffer, int length);
128 128
129 /** 129 /**
130 * @brief Write some data to the file 130 * @brief Writes some data to the file.
131 * 131 *
132 * @param data User data from the ecore_audio_obj_set_vio call 132 * @param data User data from the ecore_audio_obj_set_vio call
133 * @param eo_obj The Ecore_Audio object this operates on 133 * @param eo_obj The Ecore_Audio object this operates on
@@ -142,7 +142,7 @@ struct _Ecore_Audio_Vio {
142}; 142};
143 143
144/** 144/**
145 * @brief Holds the callback functions to implement virtual file IO 145 * @brief Holds the callback functions to implement virtual file IO.
146 * @since 1.8 146 * @since 1.8
147 */ 147 */
148typedef struct _Ecore_Audio_Vio Ecore_Audio_Vio; 148typedef struct _Ecore_Audio_Vio Ecore_Audio_Vio;
@@ -150,9 +150,9 @@ typedef struct _Ecore_Audio_Vio Ecore_Audio_Vio;
150/* Audio operations */ 150/* Audio operations */
151 151
152/** 152/**
153 * @brief Initialize the Ecore_Audio library. 153 * @brief Initializes the Ecore_Audio library.
154 * 154 *
155 * @return 1 or greater on success, 0 on error. 155 * @return @c 1 or greater on success, @c 0 on error.
156 * 156 *
157 * @since 1.8 157 * @since 1.8
158 * 158 *
@@ -166,9 +166,9 @@ typedef struct _Ecore_Audio_Vio Ecore_Audio_Vio;
166EAPI int ecore_audio_init(void); 166EAPI int ecore_audio_init(void);
167 167
168/** 168/**
169 * @brief Shut down the Ecore_Audio library. 169 * @brief Shuts down the Ecore_Audio library.
170 * 170 *
171 * @return 0 when the library is completely shut down, 1 or 171 * @return @c 0 when the library is completely shut down, @c 1 or
172 * greater otherwise. 172 * greater otherwise.
173 * 173 *
174 * @since 1.8 174 * @since 1.8
diff --git a/src/lib/ecore_audio/ecore_audio_obj.h b/src/lib/ecore_audio/ecore_audio_obj.h
index ad5062b..55acca2 100644
--- a/src/lib/ecore_audio/ecore_audio_obj.h
+++ b/src/lib/ecore_audio/ecore_audio_obj.h
@@ -20,7 +20,7 @@
20 20
21/** 21/**
22 * @file ecore_audio_obj.h 22 * @file ecore_audio_obj.h
23 * @brief Base Ecore_Audio object 23 * @brief Base Ecore_Audio object.
24 */ 24 */
25 25
26#ifdef __cplusplus 26#ifdef __cplusplus
diff --git a/src/lib/ecore_audio/ecore_audio_obj_in.h b/src/lib/ecore_audio/ecore_audio_obj_in.h
index 9840de8..003d5f7 100644
--- a/src/lib/ecore_audio/ecore_audio_obj_in.h
+++ b/src/lib/ecore_audio/ecore_audio_obj_in.h
@@ -20,7 +20,7 @@
20 20
21/** 21/**
22 * @file ecore_audio_obj_in.h 22 * @file ecore_audio_obj_in.h
23 * @brief Ecore_Audio Input Object 23 * @brief Ecore_Audio Input Object.
24 */ 24 */
25 25
26#ifdef __cplusplus 26#ifdef __cplusplus
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 fb37b7c..cbd7769 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 Ecore_Audio sndfile input 23 * @brief Ecore_Audio sndfile input.
24 */ 24 */
25 25
26#ifdef __cplusplus 26#ifdef __cplusplus
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 c7bb600..e25a331 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 Ecore_Audio tone input 23 * @brief Ecore_Audio tone input.
24 */ 24 */
25 25
26#ifdef __cplusplus 26#ifdef __cplusplus
@@ -35,7 +35,7 @@ extern "C"
35 */ 35 */
36 36
37/** 37/**
38 * @brief The frequency of the tone in Hz 38 * @brief The frequency of the tone in Hz.
39 * 39 *
40 * Set with @ref efl_key_data_set() 40 * Set with @ref efl_key_data_set()
41 */ 41 */
diff --git a/src/lib/ecore_audio/ecore_audio_obj_out.h b/src/lib/ecore_audio/ecore_audio_obj_out.h
index e8d0819..5433a7f 100644
--- a/src/lib/ecore_audio/ecore_audio_obj_out.h
+++ b/src/lib/ecore_audio/ecore_audio_obj_out.h
@@ -20,7 +20,7 @@
20 20
21/** 21/**
22 * @file ecore_audio_obj_out.h 22 * @file ecore_audio_obj_out.h
23 * @brief Ecore_Audio output object 23 * @brief Ecore_Audio output object.
24 */ 24 */
25 25
26#ifdef __cplusplus 26#ifdef __cplusplus
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 0e8ad1b..ec0ac15 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 Ecore_Audio pulseaudio output 23 * @brief Ecore_Audio pulseaudio output.
24 */ 24 */
25 25
26#ifdef __cplusplus 26#ifdef __cplusplus
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 0740cfc..f2b807d 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 Ecore_Audio sndfile output 23 * @brief Ecore_Audio sndfile output.
24 */ 24 */
25 25
26#ifdef __cplusplus 26#ifdef __cplusplus