Update code documentation for enum in EWK headers

This patch updates the code documentation for enum in EWK headers
according to the rules below.

- enum name is unnecessary
- description begins with '/**<' and the first character is capitalized

Change-Id: I84e4a2e09dac42ceb74defe8e1d0ece37f16c38c
Signed-off-by: yh106.jung <yh106.jung@samsung.com>

diff --git a/tizen_src/ewk/efl_integration/public/ewk_error.h b/tizen_src/ewk/efl_integration/public/ewk_error.h
index 84ae2f5..26c6311 100644 (file)
--- a/tizen_src/ewk/efl_integration/public/ewk_error.h
+++ b/tizen_src/ewk/efl_integration/public/ewk_error.h
@@ -44,26 +44,25 @@ extern "C" {
 typedef struct _Ewk_Error Ewk_Error;
 
 /**
- * \enum   Ewk_Error_Code
  * @brief  Enumeration that provides an option to error codes.
  * @since_tizen 2.3
  */
 typedef enum {
-  EWK_ERROR_CODE_UNKNOWN,               /* Unknown */
-  EWK_ERROR_CODE_CANCELED,              /* User canceled */
-  EWK_ERROR_CODE_CANT_SUPPORT_MIMETYPE, /* Can't show page for this MIME Type */
-  EWK_ERROR_CODE_FAILED_FILE_IO,        /* Error */
-  EWK_ERROR_CODE_CANT_CONNECT,          /* Cannot connect to Network */
-  EWK_ERROR_CODE_CANT_LOOKUP_HOST,      /* Fail to look up host from DNS */
-  EWK_ERROR_CODE_FAILED_TLS_HANDSHAKE,  /* Fail to SSL/TLS handshake */
-  EWK_ERROR_CODE_INVALID_CERTIFICATE,   /* Received certificate is invalid */
-  EWK_ERROR_CODE_REQUEST_TIMEOUT,       /* Connection timeout */
-  EWK_ERROR_CODE_TOO_MANY_REDIRECTS,    /* Too many redirects */
-  EWK_ERROR_CODE_TOO_MANY_REQUESTS,     /* Too many requests during this load */
-  EWK_ERROR_CODE_BAD_URL,               /* Malformed url */
-  EWK_ERROR_CODE_UNSUPPORTED_SCHEME,    /* Unsupported scheme */
-  EWK_ERROR_CODE_AUTHENTICATION,        /* User authentication failed on server */
-  EWK_ERROR_CODE_INTERNAL_SERVER,       /* Web server has internal server error */
+  EWK_ERROR_CODE_UNKNOWN,               /**< Unknown */
+  EWK_ERROR_CODE_CANCELED,              /**< User canceled */
+  EWK_ERROR_CODE_CANT_SUPPORT_MIMETYPE, /**< Can't show page for this MIME Type */
+  EWK_ERROR_CODE_FAILED_FILE_IO,        /**< Error */
+  EWK_ERROR_CODE_CANT_CONNECT,          /**< Cannot connect to Network */
+  EWK_ERROR_CODE_CANT_LOOKUP_HOST,      /**< Fail to look up host from DNS */
+  EWK_ERROR_CODE_FAILED_TLS_HANDSHAKE,  /**< Fail to SSL/TLS handshake */
+  EWK_ERROR_CODE_INVALID_CERTIFICATE,   /**< Received certificate is invalid */
+  EWK_ERROR_CODE_REQUEST_TIMEOUT,       /**< Connection timeout */
+  EWK_ERROR_CODE_TOO_MANY_REDIRECTS,    /**< Too many redirects */
+  EWK_ERROR_CODE_TOO_MANY_REQUESTS,     /**< Too many requests during this load */
+  EWK_ERROR_CODE_BAD_URL,               /**< Malformed url */
+  EWK_ERROR_CODE_UNSUPPORTED_SCHEME,    /**< Unsupported scheme */
+  EWK_ERROR_CODE_AUTHENTICATION,        /**< User authentication failed on server */
+  EWK_ERROR_CODE_INTERNAL_SERVER,       /**< Web server has internal server error */
 } Ewk_Error_Code;
 
 /**

diff --git a/tizen_src/ewk/efl_integration/public/ewk_manifest.h b/tizen_src/ewk/efl_integration/public/ewk_manifest.h
index 65743c9..6dceb25 100644 (file)
--- a/tizen_src/ewk/efl_integration/public/ewk_manifest.h
+++ b/tizen_src/ewk/efl_integration/public/ewk_manifest.h
@@ -35,15 +35,15 @@ typedef struct _Ewk_View_Request_Manifest Ewk_View_Request_Manifest;
  * @since_tizen 3.0
  */
 enum _Ewk_View_Orientation_Type {
-  WebScreenOrientationLockDefault = 0, /**< Equivalent to unlock. */
-  WebScreenOrientationLockPortraitPrimary, /**< portrait-primary */
-  WebScreenOrientationLockPortraitSecondary, /**< portrait-secondary */
-  WebScreenOrientationLockLandscapePrimary, /**< landscape-primary */
-  WebScreenOrientationLockLandscapeSecondary, /**< landscape-secondary */
-  WebScreenOrientationLockAny, /**< any */
-  WebScreenOrientationLockLandscape, /**< landscape */
-  WebScreenOrientationLockPortrait, /**< portrait */
-  WebScreenOrientationLockNatural, /**< natural */
+  WebScreenOrientationLockDefault = 0,        /**< Equivalent to unlock. */
+  WebScreenOrientationLockPortraitPrimary,    /**< Portrait-primary */
+  WebScreenOrientationLockPortraitSecondary,  /**< Portrait-secondary */
+  WebScreenOrientationLockLandscapePrimary,   /**< Landscape-primary */
+  WebScreenOrientationLockLandscapeSecondary, /**< Landscape-secondary */
+  WebScreenOrientationLockAny,                /**< Any */
+  WebScreenOrientationLockLandscape,          /**< Landscape */
+  WebScreenOrientationLockPortrait,           /**< Portrait */
+  WebScreenOrientationLockNatural,            /**< Natural */
 };
 
 /**
@@ -54,8 +54,6 @@ enum _Ewk_View_Orientation_Type {
 typedef enum _Ewk_View_Orientation_Type Ewk_View_Orientation_Type;
 
 /**
- * \enum _Ewk_View_Web_Display_Mode
- *
  * @brief  Enumeration that provides the mode of web display.
  *         These are attributes representing how the web application is being
  *         presented within the context.
@@ -65,11 +63,11 @@ typedef enum _Ewk_View_Orientation_Type Ewk_View_Orientation_Type;
  * @since_tizen 3.0
  */
 enum _Ewk_View_Web_Display_Mode {
-  WebDisplayModeUndefined = 0,
-  WebDisplayModeBrowser,
-  WebDisplayModeMinimalUi,
-  WebDisplayModeStandalone,
-  WebDisplayModeFullscreen,
+  WebDisplayModeUndefined = 0, /**< Undefined */
+  WebDisplayModeBrowser,       /**< Browser */
+  WebDisplayModeMinimalUi,     /**< Minimal UI */
+  WebDisplayModeStandalone,    /**< Standalone */
+  WebDisplayModeFullscreen,    /**< Fullscreen */
   WebDisplayModeLast = WebDisplayModeFullscreen
 };