apply Header review from Contents TG

Change-Id: I1b6382611c9965619351fccf63b82ce4aefcf5c3
Signed-off-by: tawhwan.son <tawhwan.son@samsung.com>

diff --git a/inc/FUixSensorMotion.h b/inc/FUixSensorMotion.h
index 43d436d..7f0d00c 100644 (file)
--- a/inc/FUixSensorMotion.h
+++ b/inc/FUixSensorMotion.h
@@ -117,7 +117,7 @@ public:
 //Operation
 public:
        /**
-        * Initializes this instance of %Motion with the specified listener.
+        * Initializes this instance of %Motion with the specified @c listener.
         *
         * @since       2.0
         *
@@ -133,7 +133,7 @@ public:
 
        /**
         * Sets the motion event type. @n
-        * If this method is not called, then by default all the motion event types will be captured by the listener.
+        * If the %SetEnabled() method is not called, then by default all the motion event types will be captured by the listener.
         * If the motion events are not be captured, this method can be called with @c type set to @c MOTION_TYPE_NONE.
         *
         * @since       2.0

diff --git a/inc/FUixSensorSensorManager.h b/inc/FUixSensorSensorManager.h
index d02853e..3de6882 100644 (file)
--- a/inc/FUixSensorSensorManager.h
+++ b/inc/FUixSensorSensorManager.h
@@ -189,7 +189,7 @@ public:
        * @if OSPCOMPAT
        * @page         CompSensorManagerAddSensorListenerPage Compatibility for AddSensorListener()
        * @section      CompSensorManagerAddSensorListenerIssueSection Issues
-       * Implementing this method in OSP compatible applications has the following issues:   @n
+       * Implementing this method in OSP compatible applications has the following issues: @n
        * -# The method returns E_DEVICE_UNAVAILABLE if the target device does not support the specific sensor.
        *
        * @section      CompSensorManagerAddSensorListenerSolutionSection Resolutions
@@ -224,7 +224,7 @@ public:
        * @if OSPCOMPAT
        * @page                    CompSensorManagerRemoveSensorListenerPage Compatibility for RemoveSensorListener()
        * @section                 CompSensorManagerRemoveSensorListenerIssueSection Issues
-       * Implementing this method in OSP compatible applications has the following issues:   @n
+       * Implementing this method in OSP compatible applications has the following issues: @n
        * -# The method returns E_DEVICE_UNAVAILABLE if the target device does not support the specific sensor.
        *
        * @section                 CompSensorManagerRemoveSensorListenerSolutionSection Resolutions
@@ -261,7 +261,7 @@ public:
         * @if OSPCOMPAT
        * @page                    CompSensorManagerRemoveSensorListenerPage Compatibility for RemoveSensorListener ()
        * @section                   CompSensorManagerRemoveSensorListenerIssueSection Issues
-       * Implementing this method in OSP compatible applications has the following issues:   @n
+       * Implementing this method in OSP compatible applications has the following issues: @n
        * -# The method returns E_DEVICE_UNAVAILABLE if the target device does not support the specific sensor.
        *
        * @section                 CompSensorManagerRemoveSensorListenerSolutionSection Resolutions
@@ -305,7 +305,7 @@ public:
        * @if OSPCOMPAT
        * @page                    CompSensorManagerSetIntervalPage Compatibility for SetInterval ()
        * @section                   CompSensorManagerSetIntervalIssueSection Issues
-       * Implementing this method in OSP compatible applications has the following issues:   @n
+       * Implementing this method in OSP compatible applications has the following issues: @n
        * -# The method returns E_DEVICE_UNAVAILABLE if the target device does not support the specific sensor.
        *
        * @section                 CompSensorManagerSetIntervalSolutionSection Resolutions
@@ -343,7 +343,7 @@ public:
        * @if OSPCOMPAT
        * @page                    CompSensorManagerSetIntervalPage Compatibility for SetInterval ()
        * @section                   CompSensorManagerSetIntervalIssueSection Issues
-       * Implementing this method in OSP compatible applications has the following issues:   @n
+       * Implementing this method in OSP compatible applications has the following issues: @n
        * -# The method returns E_DEVICE_UNAVAILABLE if the target device does not support the specific sensor.
        *
        * @section                 CompSensorManagerSetIntervalSolutionSection Resolutions
@@ -376,7 +376,7 @@ public:
        * @if OSPCOMPAT
        * @page                    CompSensorManagerIsAvailablePage Compatibility for IsAvailable ()
        * @section                   CompSensorManagerIsAvailableIssueSection Issues
-       * Implementing this method in OSP compatible applications has the following issues:   @n
+       * Implementing this method in OSP compatible applications has the following issues: @n
        * -# The method returns E_DEVICE_UNAVAILABLE if the target device does not support the specific sensor.
        *
        * @section                 CompSensorManagerIsAvailableSolutionSection Resolutions
@@ -410,7 +410,7 @@ public:
     * @if OSPCOMPAT
        * @page                    CompSensorManagerGetMinIntervalPage Compatibility for GetMinInterval()
        * @section                   CompSensorManagerGetMinIntervalIssueSection Issues
-       * Implementing this method in OSP compatible applications has the following issues:   @n
+       * Implementing this method in OSP compatible applications has the following issues: @n
        * -# The method returns E_DEVICE_UNAVAILABLE if the target device does not support the specific sensor.
        *
        * @section                 CompSensorManagerGetMinIntervalSolutionSection Resolutions
@@ -444,7 +444,7 @@ public:
        * @if OSPCOMPAT
        * @page                    CompSensorManagerGetMaxIntervalPage Compatibility for GetMaxInterval()
        * @section                   CompSensorManagerGetMaxIntervalIssueSection Issues
-       * Implementing this method in OSP compatible applications has the following issues:   @n
+       * Implementing this method in OSP compatible applications has the following issues: @n
        * -# The method returns E_DEVICE_UNAVAILABLE if the target device does not support the specific sensor.
        *
        * @section                 CompSensorManagerGetMaxIntervalSolutionSection Resolutions
@@ -479,7 +479,7 @@ public:
        * @if OSPCOMPAT
        * @page                    CompSensorManagerGetDescriptionPage Compatibility for GetDescription()
        * @section                   CompSensorManagerGetDescriptionIssueSection Issues
-       * Implementing this method in OSP compatible applications has the following issues:   @n
+       * Implementing this method in OSP compatible applications has the following issues: @n
        * -# The method returns E_DEVICE_UNAVAILABLE if the target device does not support the specific sensor.
        *
        * @section                 CompSensorManagerGetDescriptionSolutionSection Resolutions
@@ -513,7 +513,7 @@ public:
        * @if OSPCOMPAT
        * @page                    CompSensorManagerGetVendorPage Compatibility for GetVendor()
        * @section                   CompSensorManagerGetVendorIssueSection Issues
-       * Implementing this method in OSP compatible applications has the following issues:   @n
+       * Implementing this method in OSP compatible applications has the following issues: @n
        * -# The method returns E_DEVICE_UNAVAILABLE if the target device does not support the specific sensor.
        *
        * @section                 CompSensorManagerGetVendorSolutionSection Resolutions
@@ -548,7 +548,7 @@ public:
        * @if OSPCOMPAT
        * @page                    CompSensorManagerGetModelIdPage Compatibility for GetModelId()
        * @section                   CompSensorManagerGetModelIdIssueSection Issues
-       * Implementing this method in OSP compatible applications has the following issues:   @n
+       * Implementing this method in OSP compatible applications has the following issues: @n
        * -# The method returns E_DEVICE_UNAVAILABLE if the target device does not support the specific sensor.
        *
        * @section                 CompSensorManagerGetModelIdSolutionSection Resolutions
@@ -586,7 +586,7 @@ public:
        * @if OSPCOMPAT
        * @page                    CompSensorManagerGetMeasurementRangePage Compatibility for GetMeasurementRange()
        * @section                   CompSensorManagerGetMeasurementRangeIssueSection Issues
-       * Implementing this method in OSP compatible applications has the following issues:   @n
+       * Implementing this method in OSP compatible applications has the following issues: @n
        * -# The method returns E_DEVICE_UNAVAILABLE if the target device does not support the specific sensor.
        *
        * @section                 CompSensorManagerGetMeasurementRangeSolutionSection Resolutions
@@ -624,7 +624,7 @@ public:
        * @if OSPCOMPAT
        * @page                    CompSensorManagerIsWakeupSupportedPage Compatibility for IsWakeupSupported()
        * @section                   CompSensorManagerIsWakeupSupportedIssueSection Issues
-       * Implementing this method in OSP compatible applications has the following issues:   @n
+       * Implementing this method in OSP compatible applications has the following issues: @n
        * -# The method returns E_DEVICE_UNAVAILABLE if the target device does not support the specific sensor.
        *
        * @section                 CompSensorManagerIsWakeupSupportedSolutionSection Resolutions
@@ -664,7 +664,7 @@ public:
        * @if OSPCOMPAT
        * @page                    CompSensorManagerSetWakeupEnabledPage Compatibility for SetWakeupEnabled()
        * @section                   CompSensorManagerSetWakeupEnabledIssueSection Issues
-       * Implementing this method in OSP compatible applications has the following issues:   @n
+       * Implementing this method in OSP compatible applications has the following issues: @n
        * -# The method returns E_DEVICE_UNAVAILABLE if the target device does not support the specific sensor.
        *
        * @section                 CompSensorManagerSetWakeupEnabledSolutionSection Resolutions
@@ -701,7 +701,7 @@ public:
        * @if OSPCOMPAT
        * @page                    CompSensorManagerIsWakeupEnabledPage Compatibility for IsWakeupEnabled()
        * @section                   CompSensorManagerIsWakeupEnabledIssueSection Issues
-       * Implementing this method in OSP compatible applications has the following issues:   @n
+       * Implementing this method in OSP compatible applications has the following issues: @n
        * -# The method returns E_DEVICE_UNAVAILABLE if the target device does not support the specific sensor.
        *
        * @section                 CompSensorManagerIsWakeupEnabledSolutionSection Resolutions

diff --git a/inc/FUixSensorSensorTypes.h b/inc/FUixSensorSensorTypes.h
index 388b779..4459452 100644 (file)
--- a/inc/FUixSensorSensorTypes.h
+++ b/inc/FUixSensorSensorTypes.h
@@ -63,7 +63,7 @@ enum SensorType
 *
 * @since      2.0
 *
-* @remarks    Use actual key type, such as Tizen::Uix::Sensor::AccelerationDataKey, Tizen::Uix::Sensor::MagneticDataKey, Tizen::Uix::Sensor::ProximityDataKey or Tizen::Uix::Sensor::TiltDataKey with type casting. For example, use Tizen::Uix::Sensor::SensorData::GetValue(static_cast<SensorDataKey>(ACCELERATION_DATA_KEY_X), value) to get the acceleration value in x-axis.
+* @remarks    Use actual key type, such as Tizen::Uix::Sensor::AccelerationDataKey, Tizen::Uix::Sensor::MagneticDataKey, Tizen::Uix::Sensor::ProximityDataKey, or Tizen::Uix::Sensor::TiltDataKey with type casting. For example, use Tizen::Uix::Sensor::SensorData::GetValue(static_cast<SensorDataKey>(ACCELERATION_DATA_KEY_X), value) to get the acceleration value in x-axis.
 */
 enum SensorDataKey
 {