update header for Doxygen
authorMinkyoung Kang <mklove.kang@samsung.com>
Tue, 30 Apr 2013 08:10:20 +0000 (17:10 +0900)
committerMinkyoung Kang <mklove.kang@samsung.com>
Tue, 30 Apr 2013 08:10:20 +0000 (17:10 +0900)
Change-Id: Ia8311cd67cc7a2c64b59e7d562338d1c2e8d77bb

inc/FMediaCamera.h
inc/FMediaIVideoRecorderEventListener.h
inc/FMediaPlayer.h
inc/FMediaVideoRecorder.h

index fd36d42..7cb0fc0 100755 (executable)
@@ -292,10 +292,10 @@ public:
        *                       - The ICameraEventListener::OnCameraPreviewed() method can be delayed or dropped depending on
        *                       the system's performance.
        *                       - For more information on the relationship between this method and the PowerOn() method, and the
-       *                       state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm
+       *                       state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm
        ">here</a>.
        *                       - Before calling this method, check whether the feature is supported by MediaCapability::GetValue(const Tizen::Base::String& key, bool& value)
-       *            with ::CAMERA_PRIMARY_SUPPORT_PREVIEW or ::CAMERA_SECONDARY_SUPPORT_PREVIEW keys.
+       *                       with ::CAMERA_PRIMARY_SUPPORT_PREVIEW or ::CAMERA_SECONDARY_SUPPORT_PREVIEW keys.
        * @see          StopPreview()
        * @see          ICameraEventListener::OnCameraPreviewed()
        */
@@ -350,14 +350,14 @@ public:
        * @exception    E_OUT_OF_MEMORY                         The memory is insufficient.
        * @exception    E_PRIVILEGE_DENIED                      The application does not have the privilege to call this method.
        * @remarks
-       *                       -For more information on the relationship between this method and the PowerOn() method, and the
-       *                       state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm
+       *                       - For more information on the relationship between this method and the PowerOn() method, and the
+       *                       state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm
        ">here</a>.
        *                       - Before calling this method, check whether the feature is supported by MediaCapability::GetValue(const Tizen::Base::String& key, bool& value)
-       *            with ::CAMERA_PRIMARY_SUPPORT_CAPTURE or ::CAMERA_SECONDARY_SUPPORT_CAPTURE keys.
+       *                       with ::CAMERA_PRIMARY_SUPPORT_CAPTURE or ::CAMERA_SECONDARY_SUPPORT_CAPTURE keys.
        *                       -In a zero-shutter-lag camera, the state changes to ::CAMERA_STATE_PREVIEW after capturing.
        *                       -The zero-shutter-lag capability can be checked using MediaCapability::GetValue(const Tizen::Base::String& key, bool& value) with
-       *                               ::CAMERA_PRIMARY_SUPPORT_ZERO_SHUTTER_LAG, ::CAMERA_SECONDARY_SUPPORT_ZERO_SHUTTER_LAG keys.
+       *                       ::CAMERA_PRIMARY_SUPPORT_ZERO_SHUTTER_LAG, ::CAMERA_SECONDARY_SUPPORT_ZERO_SHUTTER_LAG keys.
        * @see                  ICameraEventListener::OnCameraCaptured()
        */
        result Capture(void);
@@ -400,9 +400,9 @@ public:
        *                       - The device's supported range for the brightness level is from @c 0 to @c 9.
        *                       - This method works correctly when PowerOn() is executed. @n
        *                        For more information on the relationship between this method and the PowerOn() method, and the
-       *            state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm">here</a>.
+       *                       state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm">here</a>.
        *                       - Before calling this method, check whether the feature is supported by MediaCapability::GetValue(const Tizen::Base::String& key, bool& value)
-       *            with ::CAMERA_PRIMARY_SUPPORT_BRIGHTNESS or ::CAMERA_SECONDARY_SUPPORT_BRIGHTNESS keys.
+       *                       with ::CAMERA_PRIMARY_SUPPORT_BRIGHTNESS or ::CAMERA_SECONDARY_SUPPORT_BRIGHTNESS keys.
        * @see                  GetBrightness()
        */
        result SetBrightness(int brightness);
@@ -445,9 +445,9 @@ public:
        *                       - The device's supported range for the contrast level is from @c 0 to @c 9.
        *                       - This method works correctly when PowerOn() is executed. @n
        *                       For more information on the relationship between this method and the PowerOn() method, and the
-       *           state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm">here</a>.
+       *                       state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm">here</a>.
        *                       - Before calling this method, check whether the feature is supported by MediaCapability::GetValue(const Tizen::Base::String& key, bool& value)
-       *            with ::CAMERA_PRIMARY_SUPPORT_CONTRAST or ::CAMERA_SECONDARY_SUPPORT_CONTRAST keys.
+       *                       with ::CAMERA_PRIMARY_SUPPORT_CONTRAST or ::CAMERA_SECONDARY_SUPPORT_CONTRAST keys.
        * @see                  GetContrast()
        */
        result SetContrast(int contrast);
@@ -485,13 +485,13 @@ public:
        * @remarks
        *                       - This method returns @c E_UNSUPPORTED_OPERATION in the Emulator.
        *                       - Before calling this method, check whether the feature is supported by MediaCapability::GetValue(const Tizen::Base::String& key, bool& value)
-       *            with ::CAMERA_PRIMARY_SUPPORT_ZOOM or ::CAMERA_SECONDARY_SUPPORT_ZOOM keys.
+       *                       with ::CAMERA_PRIMARY_SUPPORT_ZOOM or ::CAMERA_SECONDARY_SUPPORT_ZOOM keys.
        *                       - If Camera supports only ::CAMERA_ZOOM_TYPE_SMART, the zoom ratio can differ according
        *                       to the preview, capture, and recording resolutions.
        *                       - The supported zoom types can be obtained by using the
        *                       MediaCapability::GetValueN(CAMERA_PRIMARY_ZOOM_TYPE) method.
-       *         - For more information on the relationship between this method and the PowerOn() method, and the
-       *           state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm">here</a>.
+       *                       - For more information on the relationship between this method and the PowerOn() method, and the
+       *                       state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm">here</a>.
        * @see                  ZoomOut()
        * @see          GetZoomLevel()
        * @see          GetMaxZoomLevel()
@@ -580,9 +580,9 @@ public:
        * @exception    E_DEVICE_FAILED                         The device operation has failed.
        * @exception    E_PRIVILEGE_DENIED                      The application does not have the privilege to call this method.
        * @remarks
-       *                       -This method works in the ::CAMERA_STATE_INITIALIZED state. @n@n
-       *                       -For more information on the relationship between this method and the PowerOn() method, and the
-       *                       state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm
+       *                       - This method works in the ::CAMERA_STATE_INITIALIZED state. @n@n
+       *                       - For more information on the relationship between this method and the PowerOn() method, and the
+       *                       state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm
        ">here</a>.
        * @see                  GetPreviewResolution()
        */
@@ -642,11 +642,11 @@ public:
        * @exception    E_OUT_OF_MEMORY                         The memory is insufficient.
        * @exception    E_PRIVILEGE_DENIED                      The application does not have the privilege to call this method.
        * @remarks
-       *                       -For more information on the relationship between this method and the PowerOn() method, and the
+       *                       - For more information on the relationship between this method and the PowerOn() method, and the
        *                       state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm
        ">here</a>.
-       *                       -In a zero-shutter-lag camera, the default preview format applies this feature correctly. The other preview formats are not guaranteed.
-       *                       -The zero-shutter-lag capability can be checked using MediaCapability::GetValue(const Tizen::Base::String& key, bool& value) with
+       *                       - In a zero-shutter-lag camera, the default preview format applies this feature correctly. The other preview formats are not guaranteed.
+       *                       - The zero-shutter-lag capability can be checked using MediaCapability::GetValue(const Tizen::Base::String& key, bool& value) with
        *                       ::CAMERA_PRIMARY_SUPPORT_ZERO_SHUTTER_LAG, ::CAMERA_SECONDARY_SUPPORT_ZERO_SHUTTER_LAG keys.
        * @see                  GetCaptureResolution()
        */
@@ -704,9 +704,9 @@ public:
        * @exception    E_OUT_OF_MEMORY                         The memory is insufficient.
        * @exception    E_PRIVILEGE_DENIED                      The application does not have the privilege to call this method.
        * @remarks
-       *                       -The default effect is @c CAMERA_EFFECT_NONE.
-       *                       -This method returns @c E_UNSUPPORTED_OPERATION in the Emulator.
-       *                       -This method works correctly when PowerOn() is executed. @n@n
+       *                       - The default effect is @c CAMERA_EFFECT_NONE.
+       *                       - This method returns @c E_UNSUPPORTED_OPERATION in the Emulator.
+       *                       - This method works correctly when PowerOn() is executed. @n
        *                       For more information on the relationship between this method and the PowerOn() method, and the
        *                       state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm
        ">here</a>.
@@ -1384,9 +1384,9 @@ public:
        * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
        * @exception    E_SYSTEM                                        A system error has occurred.
        * @remarks
-       *                       -This method sets the GPS coordinates and enables entering the coordinates into the Exchangeable Image File Format (EXIF).
+       *                       - This method sets the GPS coordinates and enables entering the coordinates into the Exchangeable Image File Format (EXIF).
        *                       -By default, the GPS coordinates are not entered in JPEG's EXIF.
-       *                       -The GPS coordinates that are set using this method are entered in every call to the
+       *                       - The GPS coordinates that are set using this method are entered in every call to the
        *                       Capture() method, until DisableExifGpsCoordinates() is called or this instance is destroyed.
        *                       - This method works correctly when PowerOn() is executed.
        *                       - The values set by this method can result in an error as compared to the values stored in the Exchangeable Image File Format (EXIF) field.
@@ -1432,12 +1432,12 @@ public:
        * @exception    E_UNSUPPORTED_TYPE          The specified @c flip is not supported.
        * @exception    E_SYSTEM                                        A system error has occurred.
        * @remarks
-       *                       -This method works in the ::CAMERA_STATE_INITIALIZED state.
-       *                       -Finally the last specified type is applied even with the several types applicable.
+       *                       - This method works in the ::CAMERA_STATE_INITIALIZED state.
+       *                       - Finally the last specified type is applied even with the several types applicable.
        *                       - Before calling this method, check whether the feature is supported by MediaCapability::GetValueN(const Tizen::Base::String& key)
        *                       with @c CAMERA_PRIMARY_FLIP or @c CAMERA_SECONDARY_FLIP keys.
-       *                       -In a zero-shutter-lag camera, the default preview format is not guaranteed to apply this feature correctly.
-       *                       -The zero-shutter-lag capability can be checked using MediaCapability::GetValue(const Tizen::Base::String& key, bool& value) with
+       *                       - In a zero-shutter-lag camera, the default preview format is not guaranteed to apply this feature correctly.
+       *                       - The zero-shutter-lag capability can be checked using MediaCapability::GetValue(const Tizen::Base::String& key, bool& value) with
        *                       ::CAMERA_PRIMARY_SUPPORT_ZERO_SHUTTER_LAG, ::CAMERA_SECONDARY_SUPPORT_ZERO_SHUTTER_LAG keys.
        * @see          GetFlip()
        */
index 2e7cc19..929f7c1 100755 (executable)
@@ -133,7 +133,7 @@ public:
        *       @remarks                        
        *                               - ::RECORDER_ERROR_OUT_OF_STORAGE occurs when the recording size exceeds the maximum available capacity.
        *                               - While recording to an external memory like MMC card, ::RECORDER_ERROR_STORAGE_FAILED can occur.
-       *                               - @c RECORDER_ERROR_DEVICE_FAILED occurs when the recording device has a problem like damaged shape or h/w failure.
+       *                               - ::RECORDER_ERROR_DEVICE_FAILED occurs when the recording device has a problem like damaged shape or h/w failure.
        */
        virtual void OnVideoRecorderErrorOccurred(RecorderErrorReason r) = 0;
 
index 28e0a6f..a13e2be 100755 (executable)
@@ -663,8 +663,8 @@ public:
        * @exception    E_SYSTEM            A system error has occurred.
        * @remarks       
        *                       - This method returns a stream information of the media, which is currently being opened.
-       *                       - The specific error code can be accessed using the GetLastResult() method.
-       *                 - This method is valid in the ::PLAYER_STATE_OPENED, ::PLAYER_STATE_PLAYING, ::PLAYER_STATE_PAUSED, and ::PLAYER_STATE_STOPPED states of this instance.
+       *                       - The specific error code can be accessed using the GetLastResult() method.
+       *                       - This method is valid in the ::PLAYER_STATE_OPENED, ::PLAYER_STATE_PLAYING, ::PLAYER_STATE_PAUSED, and ::PLAYER_STATE_STOPPED states of this instance.
        */
        MediaStreamInfo* GetCurrentMediaStreamInfoN(void) const;
 
index 3c7e978..9e3293d 100755 (executable)
@@ -527,7 +527,7 @@ public:
        * @exception    E_OUT_OF_MEMORY                 The memory is insufficient.
        * @remarks              
        *                       - The specific error code can be accessed using the GetLastResult() method.
-       *                       - The return value must be released by the caller.
+       *                       - The return value must be released by the caller.
        * @see                  SetFormat( CodecType audioCodec, CodecType videoCodec, MediaContainerType container )
        * @see                  GetFormat( CodecType& audioCodec, CodecType& videoCodec, MediaContainerType& container ) const
        */
@@ -546,7 +546,7 @@ public:
        * @exception    E_OUT_OF_MEMORY                 The memory is insufficient.
        * @remarks              
        *                       - The specific error code can be accessed using the GetLastResult() method.
-       *                       - The return value must be released by the caller.
+       *                       - The return value must be released by the caller.
        * @see                  SetFormat( CodecType audioCodec, CodecType videoCodec, MediaContainerType container )
        * @see                  GetFormat( CodecType& audioCodec, CodecType& videoCodec, MediaContainerType& container ) const
        */