apply feature doxygen
authorchanil.byun <chanil.byun@samsung.com>
Tue, 26 Mar 2013 06:28:55 +0000 (15:28 +0900)
committerchanil.byun <chanil.byun@samsung.com>
Tue, 26 Mar 2013 06:30:35 +0000 (15:30 +0900)
Change-Id: I21ed5eec24ea002936e65d09a92c280fe67152e2
Signed-off-by: chanil.byun <chanil.byun@samsung.com>
inc/FLocLocationProvider.h

index 24f8371..22cc5a0 100644 (file)
@@ -81,11 +81,15 @@ public:
        *
        * @since 2.0
        *
+       * @feature      %http://tizen.org/feature/location
        * @return       An error code
        * @param[in]    criteria        The desired location criteria
        * @param[in]    listener        The listener to register
        * @exception    E_SUCCESS       The method is successful.
        * @exception    E_SYSTEM        A system error has occurred.
+       * @exception    E_UNSUPPORTED_OPERATION   The Emulator or target device does not support the required feature.
+       * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+       * @remarks      Before calling this method, check whether the feature is supported by %Tizen::System::SystemInfo::GetValue() methods.
        */
        result Construct(const LocationCriteria& criteria, ILocationProviderListener& listener);
 
@@ -310,15 +314,20 @@ public:
        * @privlevel    public
        * @privilege %http://tizen.org/privilege/location
        *
+       * @feature      %http://tizen.org/feature/location
        * @return       The current location
        * @param[in]    criteria        The desired location criteria
        * @exception    E_SUCCESS       The method is successful.
        * @exception    E_LOCATION_UNAVAILABLE  The location provider fails to fix the current location.
        * @exception    E_PRIVILEGE_DENIED      The application does not have the privilege to call this method.
+       * @exception    E_UNSUPPORTED_OPERATION   The Emulator or target device does not support the required feature.
+       *                                                                               For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
        * @exception    E_USER_NOT_CONSENTED    The user blocks an application from using the location information.
        * @exception    E_SYSTEM        A system error has occurred.
-       * @remarks      This method call takes time as the location provider runs and waits for positioning system.
-       * @remarks     The specific error code can be accessed using the GetLastResult() method.
+       * @remarks      
+       *                       - This method call takes time as the location provider runs and waits for positioning system.
+       *                       - The specific error code can be accessed using the GetLastResult() method.
+       *                       - Before calling this method, check whether the feature is supported by %Tizen::System::SystemInfo::GetValue() methods.
        */
        static Location GetLocation(const LocationCriteria& criteria);
 
@@ -333,12 +342,17 @@ public:
        * @privlevel    public
        * @privilege %http://tizen.org/privilege/location
        *
+       * @feature      %http://tizen.org/feature/location
        * @return       The last location
        * @exception    E_SUCCESS       The method is successful.
        * @exception    E_LOCATION_UNAVAILABLE  The last location is unavailable.
        * @exception    E_PRIVILEGE_DENIED      The application does not have the privilege to call this method.
+       * @exception    E_UNSUPPORTED_OPERATION   The Emulator or target device does not support the required feature.
+       *                                                                               For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
        * @exception    E_USER_NOT_CONSENTED    The user blocks an application from using the location information.
-       * @remarks     The specific error code can be accessed using the GetLastResult() method.
+       * @remarks     
+       *                       - The specific error code can be accessed using the GetLastResult() method.
+       *                       - Before calling this method, check whether the feature is supported by %Tizen::System::SystemInfo::GetValue() methods.
        */
        static Location GetLastKnownLocation(void);