Revise header doxygen descriptions

[platform/core/api/audio-io.git] / include / audio_io.h

diff --git a/include/audio_io.h b/include/audio_io.h
index 9e8ff66..53e8b0e 100644 (file)
--- a/include/audio_io.h
+++ b/include/audio_io.h
@@ -132,14 +132,14 @@ typedef enum {
  */
 
 /**
- * @brief Called when audio input data is available in asynchronous(event) mode.
+ * @brief Called when audio input data is available in asynchronous (event) mode.
  *
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
- * @remarks Use audio_in_peek() to get audio in data inside callback, use audio_in_drop() after use of peeked data.
+ * @remarks Use audio_in_peek() to get 'audio in' data inside callback, use audio_in_drop() after use of peeked data.
  *
  * @param[in] handle The handle to the audio input
- * @param[in] nbytes The amount of available audio in data which can be peeked.
+ * @param[in] nbytes The amount of available 'audio in' data which can be peeked.
  * @param[in] user_data The user data passed from the callback registration function
  *
  * @see audio_in_set_stream_cb()
@@ -426,7 +426,7 @@ int audio_in_get_channel(audio_in_h input, audio_channel_e *channel);
 int audio_in_get_sample_type(audio_in_h input, audio_sample_type_e *type);
 
 /**
- * @brief Sets an asynchronous(event) callback function to handle recording PCM (pulse-code modulation) data.
+ * @brief Sets an asynchronous (event) callback function to handle recording PCM (pulse-code modulation) data.
  *
  * @details @a callback will be called when you can read a PCM data.
  * It might cause dead lock if change the state of audio handle in callback.
@@ -472,17 +472,19 @@ int audio_in_set_stream_cb(audio_in_h input, audio_in_stream_cb callback, void*
 int audio_in_unset_stream_cb(audio_in_h input);
 
 /**
- * @brief peeks from audio in buffer.
+ * @brief Peeks into the 'audio in' buffer.
  *
- * @details This function works correctly only with read, write callback. Otherwise it won't operate as intended.
+ * @details This function works correctly only with read callback. Otherwise it won't operate as intended.
  *
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
- * @remarks Works only in asynchronous(event) mode. This will just retrieve buffer pointer from audio in buffer. Drop after use.
+ * @remarks Works only in asynchronous (event) mode.
+ *          This function provides the pointer to the 'audio in' buffer. The pointed memory is owned by the platform, therefore the @a buffer should not be released by the application.
+ *          When the data in the @a buffer is not needed anymore, use audio_in_drop() with the @a input for which audio_in_peek() was called.
  *
  * @param[in] input The handle to the audio input
- * @param[out] buffer start buffer pointer of peeked audio in data
- * @param[out] length amount of audio in data to be peeked
+ * @param[out] buffer start buffer pointer of peeked 'audio in' data
+ * @param[out] length amount of 'audio in' data to be peeked
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #AUDIO_IO_ERROR_NONE Successful
@@ -497,13 +499,13 @@ int audio_in_unset_stream_cb(audio_in_h input);
 int audio_in_peek(audio_in_h input, const void **buffer, unsigned int *length);
 
 /**
- * @brief Drops peeked audio buffer.
+ * @brief Drops the 'audio in' buffer that was peeked into.
  *
- * @details This function works correctly only with read, write callback. Otherwise it won't operate as intended.
+ * @details This function works correctly only with read callback. Otherwise it won't operate as intended.
  *
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
- * @remarks Works only in asynchronous(event) mode. This will remove audio in data from actual stream buffer. Use this if peeked data is not needed anymore.
+ * @remarks Works only in asynchronous (event) mode. This will remove 'audio in' data from the actual stream buffer. Use this if peeked data is not needed anymore.
  *
  * @param[in] input The handle to the audio input
  * @return 0 on success, otherwise a negative error value
@@ -564,13 +566,13 @@ int audio_in_unset_state_changed_cb(audio_in_h input);
  */
 
 /**
- * @brief Called when audio out data can be written in asynchronous(event) mode.
+ * @brief Called when 'audio out' data can be written in asynchronous (event) mode.
  *
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @remarks Use audio_out_write() to write pcm data inside this callback.
  * @param[in] handle The handle to the audio output
- * @param[in] nbytes The amount of audio in data which can be written.
+ * @param[in] nbytes The amount of 'audio in' data which can be written.
  * @param[in] user_data The user data passed from the callback registration function
  *
  * @see audio_out_set_stream_cb()
@@ -874,7 +876,7 @@ int audio_out_get_sample_type(audio_out_h output, audio_sample_type_e *type);
 int audio_out_get_sound_type(audio_out_h output, sound_type_e *type);
 
 /**
- * @brief Sets an asynchronous(event) callback function to handle playing PCM (pulse-code modulation) data.
+ * @brief Sets an asynchronous (event) callback function to handle playing PCM (pulse-code modulation) data.
  *
  * @details @a callback will be called when you can write a PCM data.
  * It might cause dead lock if change the state of audio handle in callback.