Modify the document

The CAPI prefix is added. The feature section should be existed for each modules.

Change-Id: I5792d5230fa472ef7c612430e2597fd34319013e
Signed-off-by: Hwankyu Jhun <h.jhun@samsung.com>

diff --git a/doc/minicontrol_doc.h b/doc/minicontrol_doc.h
index f990211f2512a1472e0260219ccfede4e4ae7549..c861a2eb0bd29c6c7d41df77cc20d01c478cce64 100644 (file)
--- a/doc/minicontrol_doc.h
+++ b/doc/minicontrol_doc.h
@@ -24,11 +24,11 @@
  *    <th>Description</th>
  * </tr>
  * <tr>
- *    <td>@ref MINICONTROL_PROVIDER_MODULE </td>
+ *    <td>@ref CAPI_MINICONTROL_PROVIDER_MODULE </td>
  *    <td>Provides functions for creating EFL socket window. Application developers can make a minicontrol by composing ELF objects on this socket window</td>
  * </tr>
  * <tr>
- *    <td>@ref MINICONTROL_VIEWER_MODULE </td>
+ *    <td>@ref CAPI_MINICONTROL_VIEWER_MODULE </td>
  *    <td>Provides functions for displaying EFL socket window.<br>
  *    Minicontrol holders calls this functions to attach minicontrols on UI area.</td>
  * </tr>
@@ -37,30 +37,38 @@
 
 /**
  * @ingroup MINICONTROL_LIBRARY
- * @defgroup MINICONTROL_PROVIDER_MODULE  Provider
+ * @defgroup CAPI_MINICONTROL_PROVIDER_MODULE  Provider
  * @brief Minicontrol Provider APIs.
- * @section MINICONTROL_PROVIDER_MODULE_HEADER Required Header
+ * @section CAPI_MINICONTROL_PROVIDER_MODULE_HEADER Required Header
  * \#include <minicontrol-provider.h>
  *
- * @section MINICONTROL_PROVIDER_MODULE_OVERVIEW Overview
+ * @section CAPI_MINICONTROL_PROVIDER_MODULE_OVERVIEW Overview
  * It provides functions for creating EFL socket window.
+ *
+ * @section CAPI_MINICONTROL_PROVIDER_MODULE_FEATURE Related Features
+ * This API is related with the following features:\n
+ * - %http://tizen.org/feature/minicontrol\n
+ *
+ * It is recommended to design feature related codes in your application for reliability.\n
+ * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n
+ * 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="https://docs.tizen.org/application/tizen-studio/native-tools/manifest-text-editor#feature-element"><b>Feature Element</b>.</a>
  */
 
 /**
  * @ingroup MINICONTROL_LIBRARY
- * @defgroup MINICONTROL_VIEWER_MODULE  Viewer
+ * @defgroup CAPI_MINICONTROL_VIEWER_MODULE  Viewer
  * @brief Minicontrol Viewer APIs.
- * @section MINICONTROL_VIEWER_MODULE_HEADER Required Header
+ * @section CAPI_MINICONTROL_VIEWER_MODULE_HEADER Required Header
  * \#include <minicontrol-viewer.h>
  *
- * @section MINICONTROL_VIEWER_MODULE_OVERVIEW Overview
+ * @section CAPI_MINICONTROL_VIEWER_MODULE_OVERVIEW Overview
  * It provides functions for displaying EFL socket window.
- */
-
-/**
- * @section CAPI_MINICONTROL_MODULE_FEATURE Related Features
+ *
+ * @section CAPI_MINICONTROL_VIEWER_MODULE_FEATURE Related Features
  * This API is related with the following features:\n
  * - %http://tizen.org/feature/minicontrol\n
+ *
  * It is recommended to design feature related codes in your application for reliability.\n
  * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n
  * 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

diff --git a/include/minicontrol-provider.h b/include/minicontrol-provider.h
index b4fb2bfd49622f6cacac7a0a99e7ce6b8bdf1a1e..c366b1f9542151490f38455688dfc8b9dc51308c 100644 (file)
--- a/include/minicontrol-provider.h
+++ b/include/minicontrol-provider.h
@@ -35,7 +35,7 @@ extern "C" {
  */
 
 /**
- * @addtogroup MINICONTROL_PROVIDER_MODULE
+ * @addtogroup CAPI_MINICONTROL_PROVIDER_MODULE
  * @{
  */
 

diff --git a/include/minicontrol-viewer.h b/include/minicontrol-viewer.h
index ed72f805086808e23e4731e2cae6ec0b666b90bd..dffbd86afe0707996457f3bf053714dcd6ef43d1 100644 (file)
--- a/include/minicontrol-viewer.h
+++ b/include/minicontrol-viewer.h
@@ -34,7 +34,7 @@ extern "C" {
  */
 
 /**
- * @addtogroup MINICONTROL_VIEWER_MODULE
+ * @addtogroup CAPI_MINICONTROL_VIEWER_MODULE
  * @{
  */