Apply reviewed doxygen
[framework/osp/web.git] / inc / FWebCtrlGeolocationPermissionManager.h
old mode 100755 (executable)
new mode 100644 (file)
index 37dc548..1690033
 //\r
 \r
 /**\r
- * @if         VISPARTNER-MANUFACTURER\r
  * @file               FWebCtrlGeolocationPermissionManager.h\r
  * @brief              This is the header file for the %GeolocationPermissionManager class.\r
- * @visibility partner-manufacturer\r
  *\r
  * This header file contains the declarations of the %GeolocationPermissionManager class.\r
  *\r
- * @endif\r
  */\r
 #ifndef _FWEB_CTRL_GEOLOCATION_PERMISSION_MANAGER_H_\r
 #define _FWEB_CTRL_GEOLOCATION_PERMISSION_MANAGER_H_\r
@@ -41,19 +38,13 @@ namespace Tizen { namespace Web { namespace Controls
 class _GeolocationPermissionManagerImpl;\r
 \r
 /**\r
- * @if VISPARTNER-MANUFACTURER\r
  * @class              GeolocationPermissionManager\r
  * @brief              This class provides methods to manage geolocation permissions.\r
  *\r
  * @since              2.0\r
  *\r
- * @visibility partner-manufacturer\r
- * @privilege  %http://tizen.org/privilege/web.privacy\r
- *\r
- * The %GeolocationPermissionManager class provides methods to manage geolocation permissions decided by a user from origins using html5 JavaScript geolocation APIs.\r
- * @n\r
+ * The %GeolocationPermissionManager class provides methods to manage geolocation permissions decided by a user from origins using html5 JavaScript geolocation APIs. @n\r
  * Origin consists of the scheme, host, and port.\r
- * @endif\r
  */\r
 \r
 class _OSP_EXPORT_ GeolocationPermissionManager\r
@@ -62,98 +53,82 @@ class _OSP_EXPORT_ GeolocationPermissionManager
 public:\r
 \r
        /**\r
-        * @if VISPARTNER-MANUFACTURER\r
         * Gets the origin list stored at the geolocation database.\r
         *\r
         * @since               2.0\r
+        * @privlevel           platform\r
+        * @privilege   %http://tizen.org/privilege/geolocationpermission.read\r
         *\r
-        * @visibility  partner-manufacturer\r
-        * @privilege   %http://tizen.org/privilege/web.privacy\r
-        *\r
-        * @return      A pointer to IList containing origin(Tizen::Base::String) list, @n\r
+        * @return              A pointer to Tizen::Base::Collection::IList that contains the origin(Tizen::Base::String) list, @n\r
         *                              else @c null if no geolocation permission data exists\r
-        * @exception E_SUCCESS                 The method is successful.\r
-        * @exception E_SERVICE_BUSY            The dedicated service module is too busy to handle another request.\r
-        * @exception E_PRIVILEGE_DENIED        The application does not have the privilege to call this method.\r
+        * @exception   E_SUCCESS                       The method is successful.\r
+        * @exception   E_SYSTEM                        The method cannot proceed due to a severe system error.\r
+        * @exception   E_PRIVILEGE_DENIED      The application does not have the privilege to call this method.\r
         * @remarks     The specific error code can be accessed using the GetLastResult() method.\r
-        * @endif\r
         */\r
         Tizen::Base::Collection::IList* GetOriginListN(void) const;\r
 \r
        /**\r
-        * @if VISPARTNER-MANUFACTURER\r
         * Checks whether geolocation permission is allowed or not for the specified @c origin.\r
         *\r
         * @since               2.0\r
+        * @privlevel   platform\r
+        * @privilege   %http://tizen.org/privilege/geolocationpermission.read\r
         *\r
-        * @visibility  partner-manufacturer\r
-        * @privilege   %http://tizen.org/privilege/web.privacy\r
-        *\r
-        * @return      @c true if geolocation permission is allowed, @n\r
+        * @return              @c true if geolocation permission is allowed, @n\r
         *                              else @c false\r
-        * @param[in] origin    The origin\r
-        * @exception E_SUCCESS                 The method is successful.\r
-        * @exception E_DATA_NOT_FOUND  There is no permission data for the specified @c origin.\r
-        * @exception E_SERVICE_BUSY            The dedicated service module is too busy to handle another request.\r
-        * @exception E_PRIVILEGE_DENIED        The application does not have the privilege to call this method.\r
-        * @remarks     The specific error code can be accessed using the GetLastResult() method.\r
-        * @endif\r
+        * @param[in]   origin                          The origin\r
+        * @exception   E_SUCCESS                       The method is successful.\r
+        * @exception   E_DATA_NOT_FOUND        There is no permission data for the specified @c origin.\r
+        * @exception   E_SYSTEM                        The method cannot proceed due to a severe system error.\r
+        * @exception   E_PRIVILEGE_DENIED      The application does not have the privilege to call this method.\r
+        * @remarks             The specific error code can be accessed using the GetLastResult() method.\r
         */\r
        bool IsPermissionAllowed(const Tizen::Base::String& origin) const;\r
 \r
        /**\r
-        * @if VISPARTNER-MANUFACTURER\r
         * Removes the geolocation data for the specified @c origin.\r
         *\r
         * @since               2.0\r
-        *\r
-        * @visibility  partner-manufacturer\r
-        * @privilege   %http://tizen.org/privilege/web.privacy\r
-        *\r
-        * @return      An error code\r
-        * @param[in] origin    The origin\r
-        * @exception E_SUCCESS                 The method is successful.\r
-        * @exception E_DATA_NOT_FOUND  There is no permission data for the specified @c origin.\r
-        * @exception E_SERVICE_BUSY            The dedicated service module is too busy to handle another request.\r
-        * @exception E_PRIVILEGE_DENIED        The application does not have the privilege to call this method.\r
+        * @privlevel   platform\r
+        * @privilege   %http://tizen.org/privilege/geolocationpermission.write\r
+        *\r
+        * @return              An error code\r
+        * @param[in]   origin                          The origin\r
+        * @exception   E_SUCCESS                       The method is successful.\r
+        * @exception   E_DATA_NOT_FOUND        There is no permission data for the specified @c origin.\r
+        * @exception   E_SYSTEM                        The method cannot proceed due to a severe system error.\r
+        * @exception   E_PRIVILEGE_DENIED      The application does not have the privilege to call this method.\r
         * @see RemoveAll()\r
-        * @endif\r
         */\r
        result Remove(const Tizen::Base::String& origin);\r
 \r
        /**\r
-        * @if VISPARTNER-MANUFACTURER\r
-        * Removes all elements in the list.\r
+        * Removes all the elements from the list.\r
         * \r
         * @since               2.0\r
+        * @privlevel   platform\r
+        * @privilege   %http://tizen.org/privilege/geolocationpermission.write\r
         *\r
-        * @visibility  partner-manufacturer\r
-        * @privilege   %http://tizen.org/privilege/web.privacy\r
-        *\r
-        * @return      An error code\r
-        * @exception E_SUCCESS                 The method is successful.\r
-        * @exception E_SERVICE_BUSY            The dedicated service module is too busy to handle another request.\r
-        * @exception E_PRIVILEGE_DENIED        The application does not have the privilege to call this method.\r
+        * @return              An error code\r
+        * @exception   E_SUCCESS                       The method is successful.\r
+        * @exception   E_SYSTEM                        The method cannot proceed due to a severe system error.\r
+        * @exception   E_PRIVILEGE_DENIED      The application does not have the privilege to call this method.\r
         * @see Remove()\r
-        * @endif\r
         */\r
        result RemoveAll(void);\r
 \r
        /**\r
-        * @if VISPARTNER-MANUFACTURER\r
         * Gets the geolocation permission manager instance.\r
         *\r
         * @since               2.0\r
         *\r
-        * @visibility  partner-manufacturer\r
-        * @privilege   %http://tizen.org/privilege/web.privacy\r
-        *\r
-        * @return      A pointer to the %GeolocationPermissionManager instance, @n\r
+        * @return              A pointer to the %GeolocationPermissionManager instance, @n\r
         *                              else @c null if it fails\r
-        * @exception E_SUCCESS                 The method is successful.\r
-        * @exception E_PRIVILEGE_DENIED        The application does not have the privilege to call this method.\r
-        * @remarks     The specific error code can be accessed using the GetLastResult() method.\r
-        * @endif\r
+        * @exception   E_SUCCESS                       The method is successful.\r
+        * @exception   E_OUT_OF_MEMORY         The memory is insufficient.\r
+        * @exception   E_SYSTEM                        The method cannot proceed due to a severe system error.\r
+        * @remarks             The specific error code can be accessed using the GetLastResult() method.\r
         */\r
        static GeolocationPermissionManager* GetInstance(void);\r
 \r
@@ -172,19 +147,19 @@ private:
        //\r
        virtual ~GeolocationPermissionManager(void);\r
 \r
-       /**\r
-        * Initializes this instance of the %Web control with the specified parameters.\r
-        *\r
-        * @since               2.0\r
-        *\r
-        * @return      An error code\r
-        */\r
+       //\r
+       // Initializes this instance of the %Web control with the specified parameters.\r
+       //\r
+       // @since               2.0\r
+       //\r
+       // @return              An error code\r
+       //\r
        result Construct(void);\r
 \r
        //\r
        // The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects.\r
        //\r
-       // @param[in] rhs               The instance of the % GeolocationPermissionManager class to copy from\r
+       // @param[in]   rhs                     The instance of the % GeolocationPermissionManager class to copy from\r
        // @remarks             This constructor is hidden.\r
        //\r
        GeolocationPermissionManager(const GeolocationPermissionManager& rhs);\r
@@ -192,21 +167,21 @@ private:
        //\r
        // Initializes the geolocation permission manager instance.\r
        //\r
-       // @since       2.0\r
+       // @since               2.0\r
        //\r
        static void InitGeolocationPermissionManager(void);\r
 \r
        //\r
        // Destroys the geolocation permission manager instance.\r
        //\r
-       // @since       2.0\r
+       // @since               2.0\r
        //\r
        static void DestroyGeolocationPermissionManager(void);\r
 \r
        //\r
        // The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects.\r
        //\r
-       // @param[in] rhs               An instance of % GeolocationPermissionManager to assign from\r
+       // @param[in]   rhs                     An instance of % GeolocationPermissionManager to assign from\r
        // @remarks             This operator is hidden.\r
        //\r
        GeolocationPermissionManager& operator=(const GeolocationPermissionManager& rhs);\r