Update API documentation

Change-Id: I5b5c08fd907e3947e0a78c70c734f9b1b6343c32

diff --git a/common/ma_defs.h b/common/ma_defs.h
index 3ffe16b6690eacfda2adaf538fc9ec785f5ba4f5..9c3d1977779e06e9f07890cb305676c1ea1bd7f1 100644 (file)
--- a/common/ma_defs.h
+++ b/common/ma_defs.h
@@ -1,5 +1,5 @@
-/**
- * Copyright (c) 2011-2018 Samsung Electronics Co., Ltd All Rights Reserved
+/*
+ * Copyright (c) 2011-2019 Samsung Electronics Co., Ltd All Rights Reserved
  *
  * Licensed under the Apache License, Version 2.0 (the License);
  * you may not use this file except in compliance with the License.

diff --git a/common/ma_main.h b/common/ma_main.h
index f5214da7e8479bd9ae31a38eb956156abbcc8f9e..ad5af7af533cd7755ac814a0c96442765daab39a 100644 (file)
--- a/common/ma_main.h
+++ b/common/ma_main.h
@@ -1,5 +1,5 @@
-/**
- * Copyright (c) 2011-2018 Samsung Electronics Co., Ltd All Rights Reserved
+/*
+ * Copyright (c) 2011-2019 Samsung Electronics Co., Ltd All Rights Reserved
  *
  * Licensed under the Apache License, Version 2.0 (the License);
  * you may not use this file except in compliance with the License.

diff --git a/doc/uix_ma_doc.h b/doc/uix_ma_doc.h
index f20b35f275f48f3596d94b00da11fec2b685620e..98327fa81ce48197990484473e8dd969f74ad1cd 100644 (file)
--- a/doc/uix_ma_doc.h
+++ b/doc/uix_ma_doc.h
@@ -1,5 +1,5 @@
-/**
- * Copyright (c) 2011-2018 Samsung Electronics Co., Ltd All Rights Reserved
+/*
+ * Copyright (c) 2011-2019 Samsung Electronics Co., Ltd All Rights Reserved
  *
  * Licensed under the Apache License, Version 2.0 (the License);
  * you may not use this file except in compliance with the License.
@@ -26,39 +26,6 @@
  * @section CAPI_UIX_MULTI_ASSISTANT_MODULE_HEADER Required Header
  * \#include <multi_assistant.h><br>
  *
- * @section CAPI_UIX_MULTI_ASSISTANT_MODULE_OVERVIEW Overview
- * A main function of Voice Control API register command and gets notification for recognition result.
- * Applications can add their own commands and be provided result when their command is recognized by user voice input.
- * To use of Voice Control, use the following steps: <br>
- * 1. Initialize <br>
- * 2. Register callback functions for notifications <br>
- * 3. Connect to voice control service asynchronously. The state should be changed to Ready <br>
- * 4. Make command list as the following step and Step 4 is called repeatedly for each command which an application wants <br>
- * 4-1. Create command list handle <br>
- * 4-2. Create command handle <br>
- * 4-3. Set command and type for command handle <br>
- * 4-4. Add command handle to command list <br>
- * 5. Set command list for recognition <br>
- * 6. Set an invocation name for an application <br>
- * 7. Get recognition results <br>
- * 8. Request the dialogue <br>
- * 9. If an application wants to finish voice control,<br>
- * 9-1. Destroy command and command list handle <br>
- * 9-2. Deinitialize <br>
- * An application can obtain command handle from command list, and also get information from handle.
- * The Voice Control API also notifies you (by callback mechanism) when the states of client and service are changed,
- * command is recognized, current language is changed or error occurred.
- * An application should register callback functions: vc_state_changed_cb(), vc_service_state_changed_cb(), vc_result_cb(),
- * vc_current_language_changed_cb(), vc_error_cb().
- *
- * @section CAPI_UIX_MULTI_ASSISTANT_MODULE_STATE_DIAGRAM State Diagram
- * The following diagram shows the life cycle and the states of the Voice Control.
- *
- * @image html capi_uix_voice_control_state_diagram.png "<State diagram>    "
- * The following diagram shows the states of Voice Control service.
- *
- * @image html capi_uix_voice_control_service_state_diagram.png "<Service state diagram>"
- *
  * @section CAPI_UIX_MULTI_ASSISTANT_MODULE_STATE_TRANSITIONS State Transitions
  * <table>
  * <tr>
@@ -68,25 +35,25 @@
  * <th>SYNC TYPE</th>
  * </tr>
  * <tr>
- * <td>vc_initialize()</td>
+ * <td>ma_initialize()</td>
  * <td>None</td>
  * <td>Initialized</td>
  * <td>SYNC</td>
  * </tr>
  * <tr>
- * <td>vc_deinitialize()</td>
+ * <td>ma_deinitialize()</td>
  * <td>Initialized</td>
  * <td>None</td>
  * <td>SYNC</td>
  * </tr>
  * <tr>
- * <td>vc_prepare()</td>
+ * <td>ma_prepare()</td>
  * <td>Initialized</td>
  * <td>Ready</td>
  * <td>ASYNC</td>
  * </tr>
  * <tr>
- * <td>vc_unprepare()</td>
+ * <td>ma_unprepare()</td>
  * <td>Ready</td>
  * <td>Initialized</td>
  * <td>SYNC</td>
@@ -104,92 +71,133 @@
 * <th>DESCRIPTION</th>
 * </tr>
 * <tr>
-* <td>vc_initialize()</td>
+* <td>ma_initialize()</td>
 * <td>None</td>
-* <td>All functions must be called after vc_initialize()</td>
+* <td>All functions must be called after ma_initialize()</td>
 * </tr>
 * <tr>
-* <td>vc_deinitialize()</td>
+* <td>ma_deinitialize()</td>
 * <td>Initialized, Ready</td>
-* <td>This function should be called when an application want to finalize voice control using</td>
+* <td>This function should be called when finished using multi-assistant</td>
 * </tr>
 * <tr>
-* <td>vc_prepare()</td>
+* <td>ma_prepare()</td>
 * <td>Initialized</td>
 * <td>This function works asynchronously. If service start is failed, application gets the error callback.</td>
 * </tr>
 * <tr>
-* <td>vc_unprepare()</td>
+* <td>ma_unprepare()</td>
 * <td>Ready</td>
 * <td></td>
 * </tr>
 * <tr>
-* <td>vc_foreach_supported_languages()</td>
+* <td>ma_get_state()</td>
 * <td>Initialized, Ready</td>
 * <td></td>
 * </tr>
 * <tr>
-* <td>vc_get_current_language()</td>
+* <td>ma_get_current_language()</td>
 * <td>Initialized, Ready</td>
 * <td></td>
 * </tr>
 * <tr>
-* <td>vc_get_state()</td>
-* <td>Initialized, Ready</td>
+* <td>ma_get_recording_audio_format()</td>
+* <td>Ready</td>
 * <td></td>
 * </tr>
 * <tr>
-* <td>vc_get_service_state()</td>
-* <td>Initialized, Ready</td>
+* <td>ma_send_asr_result()</td>
+* <td>Ready</td>
+* <td></td>
+* </tr>
+* <tr>
+* <td>ma_send_result()</td>
+* <td>Ready</td>
+* <td></td>
+* </tr>
+* <tr>
+* <td>ma_send_recognition_result()</td>
+* <td>Ready</td>
+* <td></td>
+* </tr>
+* <tr>
+* <td>ma_start_receiving_audio_streaming_data()</td>
+* <td>Ready</td>
+* <td></td>
+* </tr>
+* <tr>
+* <td>ma_stop_receiving_audio_streaming_data()</td>
+* <td>Ready</td>
+* <td></td>
+* </tr>
+* <tr>
+* <td>ma_update_voice_feedback_state()</td>
+* <td>Ready</td>
+* <td></td>
+* </tr>
+* <tr>
+* <td>ma_send_assistant_specific_command()</td>
+* <td>Ready</td>
+* <td></td>
+* </tr>
+* <tr>
+* <td>ma_assistant_info_foreach_assistants()</td>
+* <td>Ready</td>
 * <td></td>
 * </tr>
 * <tr>
-* <td>vc_get_result()</td>
+* <td>ma_assistant_info_get_app_id()</td>
 * <td>Ready</td>
 * <td></td>
 * </tr>
 * <tr>
-* <td>vc_get_system_command_list()</td>
+* <td>ma_assistant_info_get_enabled_status()</td>
 * <td>Ready</td>
 * <td></td>
 * </tr>
 * <tr>
-* <td>vc_set_command_list()</td>
+* <td>ma_get_recording_audio_source_type()</td>
 * <td>Ready</td>
 * <td></td>
 * </tr>
 * <tr>
-* <td>vc_unset_command_list()</td>
+* <td>ma_set_background_volume()</td>
 * <td>Ready</td>
 * <td></td>
 * </tr>
 * <tr>
-* <td>vc_set_invocation_name()</td>
+* <td>ma_set_preprocessing_allow_mode()</td>
 * <td>Ready</td>
 * <td></td>
 * </tr>
 * <tr>
-* <td>vc_set_server_dialog()</td>
+* <td>ma_send_preprocessing_result()</td>
 * <td>Ready</td>
 * <td></td>
 * </tr>
 * <tr>
-* <td>vc_request_dialog()</td>
+* <td>ma_set_wake_word_audio_require_flag()</td>
 * <td>Ready</td>
 * <td></td>
 * </tr>
 * <tr>
 * <td>
-* vc_set_result_cb()<br>
-* vc_unset_result_cb()<br>
-* vc_set_state_changed_cb()<br>
-* vc_unset_state_changed_cb()<br>
-* vc_set_service_state_changed_cb()<br>
-* vc_unset_service_state_changed_cb()<br>
-* vc_set_current_language_changed_cb()<br>
-* vc_unset_current_language_changed_cb()<br>
-* vc_set_error_cb()<br>
-* vc_unset_error_cb()</td>
+* ma_set_state_changed_cb()<br>
+* ma_unset_state_changed_cb()<br>
+* ma_set_error_cb()<br>
+* ma_unset_error_cb()</td>
+* ma_set_language_changed_cb()<br>
+* ma_unset_language_changed_cb()</td>
+* ma_set_audio_streaming_cb()<br>
+* ma_unset_audio_streaming_cb()</td>
+* ma_set_active_state_changed_cb()<br>
+* ma_unset_active_state_changed_cb()</td>
+* ma_set_wakeup_engine_command_cb()<br>
+* ma_unset_wakeup_engine_command_cb()</td>
+* ma_set_preprocessing_information_changed_cb()<br>
+* ma_unset_preprocessing_information_changed_cb()</td>
+* ma_set_audio_streaming_data_section_changed_cb()<br>
+* ma_unset_audio_streaming_data_section_changed_cb()</td>
 * <td>Initialized</td>
 * <td> All callback function should be registered in Initialized state </td>
 * </tr>

diff --git a/include/multi_assistant.h b/include/multi_assistant.h
index 7eba706d9acca57e9b50b096ec47fcca63182107..c8661db542a8a93d6001b11925a46adf975a3bee 100644 (file)
--- a/include/multi_assistant.h
+++ b/include/multi_assistant.h
@@ -1,5 +1,5 @@
-/**
- * Copyright (c) 2011-2018 Samsung Electronics Co., Ltd All Rights Reserved
+/*
+ * Copyright (c) 2011-2019 Samsung Electronics Co., Ltd All Rights Reserved
  *
  * Licensed under the Apache License, Version 2.0 (the License);
  * you may not use this file except in compliance with the License.
@@ -530,7 +530,6 @@ int ma_assistant_info_get_enabled_status(ma_assistant_info_h handle, bool* statu
 /**
  * @brief Gets the recording audio source type.
  * @since_tizen 5.5
- * @privlevel public
  *
  * @remarks You must release @a type using free().
  * @param[out] type The audio source type

diff --git a/include/multi_assistant_common.h b/include/multi_assistant_common.h
index abc4a9aa29dd5d3dab957885a1adb109a738fbfe..033f34772c00d16153c88b1c7077cbe8d50fe7de 100644 (file)
--- a/include/multi_assistant_common.h
+++ b/include/multi_assistant_common.h
@@ -1,5 +1,5 @@
-/**
- * Copyright (c) 2011-2018 Samsung Electronics Co., Ltd All Rights Reserved
+/*
+ * Copyright (c) 2011-2019 Samsung Electronics Co., Ltd All Rights Reserved
  *
  * Licensed under the Apache License, Version 2.0 (the License);
  * you may not use this file except in compliance with the License.

diff --git a/include/multi_assistant_settings.h b/include/multi_assistant_settings.h
index 7c35335bf713251f29cf677d98246275be73dce1..b9c1f47d9141891c1d7009745ae4998aec0d7b94 100644 (file)
--- a/include/multi_assistant_settings.h
+++ b/include/multi_assistant_settings.h
@@ -1,5 +1,5 @@
-/**
- * Copyright (c) 2011-2018 Samsung Electronics Co., Ltd All Rights Reserved
+/*
+ * Copyright (c) 2011-2019 Samsung Electronics Co., Ltd All Rights Reserved
  *
  * Licensed under the Apache License, Version 2.0 (the License);
  * you may not use this file except in compliance with the License.

diff --git a/include/multi_assistant_ui.h b/include/multi_assistant_ui.h
index 5270665494a15dfb1fd6e2370252dba4092d42ee..5441e35f4b1a9729a10b68475e5107a909e54d0a 100644 (file)
--- a/include/multi_assistant_ui.h
+++ b/include/multi_assistant_ui.h
@@ -1,5 +1,5 @@
-/**
- * Copyright (c) 2011-2018 Samsung Electronics Co., Ltd All Rights Reserved
+/*
+ * Copyright (c) 2011-2019 Samsung Electronics Co., Ltd All Rights Reserved
  *
  * Licensed under the Apache License, Version 2.0 (the License);
  * you may not use this file except in compliance with the License.