From: kibak.yoon Date: Fri, 26 May 2017 06:07:22 +0000 (+0900) Subject: sensor: fix doxygen errors X-Git-Tag: submit/tizen/20170526.063331^0 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=47ce2db2aaeb66eb1e771e8174954d98abb38a8e;p=platform%2Fcore%2Fapi%2Fsensor.git sensor: fix doxygen errors - warning: Found unknown command `\since_tizen' in API doxygen - solution : change \" to @" Change-Id: Id75d401a352afa13cb2f8b620a5e0bccbe1fa943 Signed-off-by: kibak.yoon --- diff --git a/doc/sensor_doc.h b/doc/sensor_doc.h index f786422..496b4a5 100644 --- a/doc/sensor_doc.h +++ b/doc/sensor_doc.h @@ -97,18 +97,18 @@ * also can be accessed using this URI-based method. * * @section CAPI_SYSTEM_SENSOR_LISTENER_MODULE_URI Sensor URIs - * A sensor URI is in the form of \"%http://\/sensor/\/\/\\". - * where the \"/\\" can be omitted. - * In cases of platform-defined sensors, the vendor should be \"tizen.org\". - * The category can be one of \"general\" and \"healthinfo\", - * and \"healthinfo\" means that an application should have the privilege + * A sensor URI is in the form of @"%http://\/sensor/\/\/\@". + * where the @"/\@" can be omitted. + * In cases of platform-defined sensors, the vendor should be @"tizen.org@". + * The category can be one of @"general@" and @"healthinfo@", + * and @"healthinfo@" means that an application should have the privilege * http://tizen.org/privilege/healthinfo to get the corresponding sensor handles. * If the name is omitted, the URI denotes the sensors of the given type, * it thus may correspond to more than one sensor. * Otherwise, it corresponds to a specific sensor in the device. * For example, the URI %http://tizen.org/sensor/general/light denotes * all the light sensors in the device, while %http://tizen.org/sensor/general/light/front - * only denotes the light sensor named as \"front\". + * only denotes the light sensor named as @"front@". * * Here are the platform-defined sensor URIs corresponding to the sensor types defined in #sensor_type_e:\n * - %http://tizen.org/sensor/general/accelerometer (#SENSOR_ACCELEROMETER) \n diff --git a/include/sensor.h b/include/sensor.h index 99a29af..0005065 100644 --- a/include/sensor.h +++ b/include/sensor.h @@ -176,7 +176,7 @@ int sensor_is_supported(sensor_type_e type, bool *supported); * @details To correctly check the availability of a sensor, a valid URI should be provided. * The valid form of URIs is explained in \ref CAPI_SYSTEM_SENSOR_LISTENER_MODULE_URI.\n * If a URI with the sensor's name is given, for example, %http://tizen.org/sensor/general/light/front, - * the availability of the \"front\" light sensor is checked. + * the availability of the @"front@" light sensor is checked. * Otherwise, if a URI without the name, %http://tizen.org/sensor/general/light, is given, * this function checks the availability of any light sensor in the device.\n * It is recommended to check the availability of the sensors corresponding to the URI @@ -251,8 +251,8 @@ int sensor_get_default_sensor(sensor_type_e type, sensor_h *sensor); * @since_tizen 4.0 * * @remarks Some sensor types are privileged. An application should have the privilege - * http://tizen.org/privilege/healthinfo to get handles for the sensor URIs of \"healthinfo\" category. - * See \ref CAPI_SYSTEM_SENSOR_LISTENER_MODULE_URI to find the \"healthinfo\" category sensor URIs. + * http://tizen.org/privilege/healthinfo to get handles for the sensor URIs of @"healthinfo@" category. + * See \ref CAPI_SYSTEM_SENSOR_LISTENER_MODULE_URI to find the @"healthinfo@" category sensor URIs. * * @param[in] uri A sensor or a sensor type URI to get the handle of its default sensor * @param[out] sensor The default sensor handle @@ -1064,12 +1064,12 @@ typedef struct _sensor_provider_s *sensor_provider_h; * @brief Creates a sensor provider. * @details This function creates a sensor provider handle with a given URI. * The URI should be in the valid form described in \ref CAPI_SYSTEM_SENSOR_LISTENER_MODULE_URI. - * In addition, it is not allowed to set the vendor in the URI to \"tizen.org\", + * In addition, it is not allowed to set the vendor in the URI to @"tizen.org@", * as it is pre-assigned to the platform-defined sensors.\n * @since_tizen 4.0 * * @remarks If your application needs to publish health-related sensor data, - * the URI category should be \"healthinfo\". + * the URI category should be @"healthinfo@". * Then the applications without the privilege http://tizen.org/privilege/healthinfo * are not allowed to listen your application's health-related sensor. * @@ -1746,7 +1746,7 @@ typedef enum } sensor_util_axis_e; /** - * @brief Gets the inclination matrix "I" and rotation matrix "R" transforming a vector from the device coordinate to the world's coordinate. + * @brief Gets the inclination matrix @"I@" and rotation matrix @"R@" transforming a vector from the device coordinate to the world's coordinate. * * @details [0 0 g] = R * gravity (g = magnitude of gravity) \n * [0 m 0] = I * R * geomagnetic (m = magnitude of the geomagnetic field) \n @@ -1770,9 +1770,9 @@ typedef enum * @param[in] Mx The X-axis geomagnetic vector in the device's coordinate * @param[in] My The Y-axis geomagnetic vector in the device's coordinate * @param[in] Mz The Z-axis geomagnetic vector in the device's coordinate - * @param[out] R The array of 9 floats that represent the rotation matrix "R" \n + * @param[out] R The array of 9 floats that represent the rotation matrix @"R@" \n * It can be null. - * @param[out] I The array of 9 floats that represent the inclination matrix "I" \n + * @param[out] I The array of 9 floats that represent the inclination matrix @"I@" \n * It can be null. * * @return #SENSOR_ERROR_NONE on success; Otherwise a negative error value