Add doxygen for internal APIs

[platform/core/api/audio-io.git] / doc / audio_io_doc.h

diff --git a/doc/audio_io_doc.h b/doc/audio_io_doc.h
index ee80e81..b2a82db 100644 (file)
--- a/doc/audio_io_doc.h
+++ b/doc/audio_io_doc.h
@@ -11,7 +11,7 @@
  * distributed under the License is distributed on an AS IS BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
- * limitations under the License. 
+ * limitations under the License.
  */
 
 
@@ -42,13 +42,13 @@
  * It gives easy access to the hardware layer of the sound card with a professional multichannel audio interface.
  * It should be used for activities requiring raw audio data buffers(PCM format).
  *
- * Programming the interface requires first obtaining a handle to the device, via the audio_in_create() or audio_out_create() function.
+ * Programming the interface requires first obtaining a handle to the device, via the audio_in_create() or audio_out_create_new() function.
  *
  * The input and output devices both have an available set of queries, to find the suggested buffer size, sampling rate, channel type,
  * and sample type. For output, there is an additional query, to get the sound type (these types are defined in the @ref CAPI_MEDIA_SOUND_MANAGER_MODULE API).
  *
- * Reading and writing is done by allocating a buffer and passing the buffer to the input device
- * via audio_in_start_recording(), audio_in_read(), or writing to the buffer and passing it to the output device via audio_out_write().
+ * Reading from input device is done by audio_in_read() with allocated buffer after audio_in_prepare().
+ * Similarly, writing to output device is done by audio_out_write() with allocated buffer after audio_out_prepare().
  *
  */
 
@@ -64,7 +64,7 @@
  *
  * @section CAPI_MEDIA_AUDIO_IN_MODULE_FEATURE Related Features
  * This API is related with the following features:\n
- *  - http://tizen.org/feature/microphone\n
+ *  - %http://tizen.org/feature/microphone\n
  *
  * It is recommended to design feature related codes in your application for reliability.\n
  *
@@ -72,7 +72,7 @@
  *
  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
  *
- * More details on featuring your application can be found from <a href="../org.tizen.mobile.native.appprogramming/html/ide_sdk_tools/feature_element.htm"><b>Feature Element</b>.</a>
+ * More details on featuring your application can be found from <a href="https://docs.tizen.org/application/tizen-studio/native-tools/manifest-text-editor#feature-element"><b>Feature Element</b>.</a>
  *
  */