Fix mistakes in header description

[Version] 0.1.14
[Profile] Mobile, Wearable, TV
[Issue Type] Fix description bugs

Change-Id: I4bd4fd3d46a4c1460295b911b8cf0f69405c3e6d

diff --git a/include/mediamuxer.h b/include/mediamuxer.h
index b076e9c..75f02d6 100755 (executable)
--- a/include/mediamuxer.h
+++ b/include/mediamuxer.h
@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-#ifndef __TIZEN_MEDIAMUXER_H__
-#define __TIZEN_MEDIAMUXER_H__
+#ifndef __TIZEN_MULTIMEDIA_MEDIAMUXER_H__
+#define __TIZEN_MULTIMEDIA_MEDIAMUXER_H__
 
 #include <tizen.h>
 #include <stdint.h>
@@ -37,13 +37,13 @@ extern "C" {
 */
 
 /**
- * @brief Media Muxer handle type
+ * @brief Media Muxer handle type.
  * @since_tizen 3.0
  */
 typedef struct mediamuxer_s *mediamuxer_h;
 
 /**
- * @brief Enumeration for media muxer state
+ * @brief Enumeration for media muxer state.
  * @since_tizen 3.0
  */
 typedef enum {
@@ -55,7 +55,7 @@ typedef enum {
 } mediamuxer_state_e;
 
 /**
- * @brief Enumeration for media muxer error
+ * @brief Enumeration for media muxer error.
  * @since_tizen 3.0
  */
 typedef enum {
@@ -71,7 +71,7 @@ typedef enum {
 } mediamuxer_error_e;
 
 /**
- * @brief Enumeration for media muxer output format
+ * @brief Enumeration for media muxer output format.
  * @since_tizen 3.0
  */
 typedef enum {
@@ -91,10 +91,10 @@ typedef enum {
  *          #MEDIAMUXER_ERROR_INVALID_PATH,
  *          #MEDIAMUXER_ERROR_RESOURCE_LIMIT
  * @since_tizen 3.0
- * @param[in] error        The error that occurred in media muxer
- * @param[in] user_data    The user data passed from the code where
- *                         mediamuxer_set_error_cb() was invoked
- *                         This data will be accessible from @a mediamuxer_error_cb
+ * @param[in] error     The error that occurred in media muxer
+ * @param[in] user_data The user data passed from the code where
+ *                       mediamuxer_set_error_cb() was invoked
+ *                       This data will be accessible from @user_data mediamuxer_error_cb
  * @pre Create media muxer handle by calling mediamuxer_create() function.
  * @see mediamuxer_set_error_cb()
  * @see mediamuxer_unset_error_cb()
@@ -104,9 +104,9 @@ typedef void (*mediamuxer_error_cb)(mediamuxer_error_e error, void *user_data);
 /**
  * @brief Called when end of stream occurs in media muxer.
  * @since_tizen 4.0
- * @param[in] user_data    The user data passed from the code where
- *                         mediamuxer_set_eos_cb() was invoked;\n
- *                         this data will be accessible from mediamuxer_eos_cb()
+ * @param[in] user_data The user data passed from the code where
+ *                       mediamuxer_set_eos_cb() was invoked;\n
+ *                       this data will be accessible from mediamuxer_eos_cb()
  * @pre Create media muxer handle by calling mediamuxer_create() function.
  * @see mediamuxer_set_eos_cb()
  * @see mediamuxer_unset_eos_cb()
@@ -116,7 +116,8 @@ typedef void (*mediamuxer_eos_cb)(void *user_data);
 /**
  * @brief Creates a media muxer handle for muxing.
  * @since_tizen 3.0
- * @param[out] muxer  A new handle to media muxer
+ * @remarks You must release @a muxer using mediamuxer_destroy() function.
+ * @param[out] muxer A new handle to media muxer
  * @return @c 0 on success, otherwise a negative error value
  * @retval #MEDIAMUXER_ERROR_NONE Successful
  * @retval #MEDIAMUXER_ERROR_INVALID_PARAMETER Invalid parameter
@@ -133,9 +134,9 @@ int mediamuxer_create(mediamuxer_h *muxer);
  * @remarks The mediastorage privilege(http://tizen.org/privilege/mediastorage) should be added if any video/audio files are to be saved in the internal storage.
  * @remarks The externalstorage privilege(http://tizen.org/privilege/externalstorage) should be added if any video/audio files are to be saved in the external storage.
  * @param[in] muxer  A new handle to media muxer
- * @param[in] path  The location of the output media file, such as the file path
+ * @param[in] path   The location of the output media file, such as the file path
                This is the path at which the muxed file should be saved.
- * @param[in] format  The format of the output media file
+ * @param[in] format The format of the output media file
  * @return @c 0 on success, otherwise a negative error value
  * @retval #MEDIAMUXER_ERROR_NONE Successful
  * @retval #MEDIAMUXER_ERROR_INVALID_PARAMETER Invalid parameter
@@ -150,8 +151,8 @@ int mediamuxer_set_data_sink(mediamuxer_h muxer, char *path, mediamuxer_output_f
 /**
  * @brief Adds the media track of interest to the muxer handle.
  * @since_tizen 3.0
- * @param[in] muxer     The media muxer handle
- * @param[in] media_format  The format of media muxer
+ * @param[in]  muxer        The media muxer handle
+ * @param[in]  media_format The format of media muxer
  * @param[out] track_index  The index of the media track
  * @return @c 0 on success, otherwise a negative error value
  * @retval #MEDIAMUXER_ERROR_NONE Successful
@@ -167,9 +168,9 @@ int mediamuxer_add_track(mediamuxer_h muxer, media_format_h media_format, int *t
 
 /**
  * @brief Prepares the media muxer.
- * @remarks Initiates the necessary parameters.
  * @since_tizen 3.0
- * @param[in] muxer     The media muxer handle
+ * @remarks Initiates the necessary parameters.
+ * @param[in] muxer The media muxer handle
  * @return @c 0 on success, otherwise a negative error value
  * @retval #MEDIAMUXER_ERROR_NONE Successful
  * @retval #MEDIAMUXER_ERROR_INVALID_PARAMETER Invalid parameter
@@ -184,9 +185,9 @@ int mediamuxer_prepare(mediamuxer_h muxer);
 
 /**
  * @brief Starts the media muxer.
- * @remarks Keeps the muxer ready for writing data.
  * @since_tizen 3.0
- * @param[in] muxer     The media muxer handle
+ * @remarks Keeps the muxer ready for writing data.
+ * @param[in] muxer The media muxer handle
  * @return @c 0 on success, otherwise a negative error value
  * @retval #MEDIAMUXER_ERROR_NONE Successful
  * @retval #MEDIAMUXER_ERROR_INVALID_PARAMETER Invalid parameter
@@ -202,9 +203,9 @@ int mediamuxer_start(mediamuxer_h muxer);
 /**
  * @brief Writes the media packet of interest to the muxer handle.
  * @since_tizen 3.0
- * @param[in] muxer     The media muxer handle
- * @param[in] track_index  The index of the media track
- * @param[in] inbuf  The packet of media muxer
+ * @param[in] muxer       The media muxer handle
+ * @param[in] track_index The index of the media track
+ * @param[in] inbuf       The packet of media muxer
  * @return @c 0 on success, otherwise a negative error value
  * @retval #MEDIAMUXER_ERROR_NONE Successful
  * @retval #MEDIAMUXER_ERROR_INVALID_PARAMETER Invalid parameter
@@ -222,10 +223,11 @@ int mediamuxer_write_sample(mediamuxer_h muxer, int track_index, media_packet_h
 
 /**
  * @brief Closes the track from further writing of data.
- * @remarks For each added track, user needs to call this API to indicate the end of stream.
  * @since_tizen 3.0
- * @param[in] muxer     The media muxer handle
- * @param[in] track_index the selected track index
+ * @remarks For each added track, user needs to call this function to indicate the end of stream.
+ * @param[in] muxer       The media muxer handle
+ * @param[in] track_index The selected track index
+ * @return @c 0 on success, otherwise a negative error value
  * @retval #MEDIAMUXER_ERROR_NONE Successful
  * @retval #MEDIAMUXER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIAMUXER_ERROR_INVALID_OPERATION Invalid operation
@@ -241,10 +243,10 @@ int mediamuxer_close_track(mediamuxer_h muxer, int track_index);
 
 /**
  * @brief Pauses the media muxer.
- * @remarks To temporarily disable writing data for muxing. This API pauses a playing muxer
-               If the prior state of the muxer is not in PLAYING, no action will be taken.
  * @since_tizen 3.0
- * @param[in] muxer     The media muxer handle
+ * @remarks To temporarily disable writing data for muxing. This function pauses a playing muxer
+               If the prior state of the muxer is not in PLAYING, no action will be taken.
+ * @param[in] muxer The media muxer handle
  * @return @c 0 on success, otherwise a negative error value
  * @retval #MEDIAMUXER_ERROR_NONE Successful
  * @retval #MEDIAMUXER_ERROR_INVALID_PARAMETER Invalid parameter
@@ -259,10 +261,10 @@ int mediamuxer_pause(mediamuxer_h muxer);
 
 /**
  * @brief Resumes the media muxer.
- * @remarks Make it ready for any further writing. This API will resume a paused muxer.
-               If the prior state of the muxer is not playing, no action will be taken.
  * @since_tizen 3.0
- * @param[in] muxer     The media muxer handle
+ * @remarks Make it ready for any further writing. This function will resume a paused muxer.
+               If the prior state of the muxer is not playing, no action will be taken.
+ * @param[in] muxer The media muxer handle
  * @return @c 0 on success, otherwise a negative error value
  * @retval #MEDIAMUXER_ERROR_NONE Successful
  * @retval #MEDIAMUXER_ERROR_INVALID_PARAMETER Invalid parameter
@@ -276,16 +278,16 @@ int mediamuxer_resume(mediamuxer_h muxer);
 
 /**
  * @brief Stops the media muxer.
- * @remarks Keeps the muxer ready for writing data.
  * @since_tizen 3.0
- * @param[in] muxer     The media muxer handle
+ * @remarks Keeps the muxer ready for writing data.
+ * @param[in] muxer The media muxer handle
  * @return @c 0 on success, otherwise a negative error value
  * @retval #MEDIAMUXER_ERROR_NONE Successful
  * @retval #MEDIAMUXER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIAMUXER_ERROR_INVALID_OPERATION Invalid operation
  * @retval #MEDIAMUXER_ERROR_INVALID_STATE Invalid state
  * @pre The media muxer state must be set to #MEDIAMUXER_STATE_MUXING
- *     or #MEDIAMUXER_STATE_PAUSED.
+ *      or #MEDIAMUXER_STATE_PAUSED.
  * @post The media muxer state will be #MEDIAMUXER_STATE_READY.
  * @see mediamuxer_start()
  * @see mediamuxer_unprepare()
@@ -294,9 +296,9 @@ int mediamuxer_stop(mediamuxer_h muxer);
 
 /**
  * @brief Unprepares the media muxer.
- * @remarks Unrefs the variables created after calling mediamuxer_prepare().
  * @since_tizen 3.0
- * @param[in] muxer     The media muxer handle
+ * @remarks Unrefs the variables created after calling mediamuxer_prepare().
+ * @param[in] muxer The media muxer handle
  * @return @c 0 on success, otherwise a negative error value
  * @retval #MEDIAMUXER_ERROR_NONE Successful
  * @retval #MEDIAMUXER_ERROR_INVALID_PARAMETER Invalid parameter
@@ -314,7 +316,7 @@ int mediamuxer_unprepare(mediamuxer_h muxer);
 /**
  * @brief Removes the instance of media muxer and clear all its context memory.
  * @since_tizen 3.0
- * @param[in] muxer     The media muxer handle
+ * @param[in] muxer The media muxer handle
  * @return @c 0 on success, otherwise a negative error value
  * @retval #MEDIAMUXER_ERROR_NONE Successful
  * @retval #MEDIAMUXER_ERROR_INVALID_PARAMETER Invalid parameter
@@ -329,8 +331,8 @@ int mediamuxer_destroy(mediamuxer_h muxer);
 /**
  * @brief Gets media muxer state.
  * @since_tizen 3.0
- * @param[in] muxer   The media muxer handle
- * @param[out] state   The media muxer sate
+ * @param[in]  muxer The media muxer handle
+ * @param[out] state The media muxer sate
  * @return @c 0 on success, otherwise a negative error value
  * @retval #MEDIAMUXER_ERROR_NONE Successful
  * @retval #MEDIAMUXER_ERROR_INVALID_PARAMETER Invalid parameter
@@ -341,13 +343,13 @@ int mediamuxer_destroy(mediamuxer_h muxer);
 int mediamuxer_get_state(mediamuxer_h muxer, mediamuxer_state_e *state);
 
 /**
- * @brief Registers a error callback function to be invoked when an error occurs.
+ * @brief Sets a error callback function to be invoked when an error occurs.
  * @since_tizen 3.0
- * @param[in] muxer   The media muxer handle
+ * @param[in] muxer     The media muxer handle
  * @param[in] callback  Callback function pointer
- * @param[in] user_data   The user data passed from the code where
- *                         mediamuxer_set_error_cb() was invoked
- *                         This data will be accessible from @a mediamuxer_error_cb
+ * @param[in] user_data The user data passed from the code where
+ *                       mediamuxer_set_error_cb() was invoked
+ *                       This data will be accessible from @user_data mediamuxer_error_cb
  * @return @c 0 on success, otherwise a negative error value
  * @retval #MEDIAMUXER_ERROR_NONE Successful
  * @retval #MEDIAMUXER_ERROR_INVALID_PARAMETER Invalid parameter
@@ -359,9 +361,9 @@ int mediamuxer_get_state(mediamuxer_h muxer, mediamuxer_state_e *state);
 int mediamuxer_set_error_cb(mediamuxer_h muxer, mediamuxer_error_cb callback, void *user_data);
 
 /**
- * @brief Unregisters the error callback function.
+ * @brief Unsets the error callback function.
  * @since_tizen 3.0
- * @param[in] muxer   The media muxer handle
+ * @param[in] muxer The media muxer handle
  * @return @c 0 on success, otherwise a negative error value
  * @retval #MEDIAMUXER_ERROR_NONE Successful
  * @retval #MEDIAMUXER_ERROR_INVALID_PARAMETER Invalid parameter
@@ -370,13 +372,13 @@ int mediamuxer_set_error_cb(mediamuxer_h muxer, mediamuxer_error_cb callback, vo
 int mediamuxer_unset_error_cb(mediamuxer_h muxer);
 
  /**
- * @brief Registers an EOS (end of stream) callback function to be invoked when an EOS occurs.
+ * @brief Sets an EOS (end of stream) callback function to be invoked when an EOS occurs.
  * @since_tizen 4.0
- * @param[in] muxer       The media muxer handle
- * @param[in] callback    Callback function pointer
- * @param[in] user_data   The user data passed from the code where
- *                        mediamuxer_set_eos_cb() was invoked;\n
- *                        this data will be accessible from mediamuxer_eos_cb()
+ * @param[in] muxer     The media muxer handle
+ * @param[in] callback  Callback function pointer
+ * @param[in] user_data The user data passed from the code where
+ *                       mediamuxer_set_eos_cb() was invoked;\n
+ *                       this data will be accessible from mediamuxer_eos_cb()
  * @return @c 0 on success, otherwise a negative error value
  * @retval #MEDIAMUXER_ERROR_NONE Successful
  * @retval #MEDIAMUXER_ERROR_INVALID_PARAMETER Invalid parameter
@@ -389,9 +391,9 @@ int mediamuxer_unset_error_cb(mediamuxer_h muxer);
 int mediamuxer_set_eos_cb(mediamuxer_h muxer, mediamuxer_eos_cb callback, void *user_data);
 
 /**
- * @brief Unregisters the EOS (end of stream) callback function.
+ * @brief Unsets the EOS (end of stream) callback function.
  * @since_tizen 4.0
- * @param[in] muxer   The media muxer handle
+ * @param[in] muxer The media muxer handle
  * @return @c 0 on success, otherwise a negative error value
  * @retval #MEDIAMUXER_ERROR_NONE Successful
  * @retval #MEDIAMUXER_ERROR_INVALID_PARAMETER Invalid parameter
@@ -407,4 +409,4 @@ int mediamuxer_unset_eos_cb(mediamuxer_h muxer);
 #ifdef __cplusplus
 }
 #endif
-#endif /* __TIZEN_MEDIAMUXER_H__ */
+#endif /* __TIZEN_MULTIMEDIA_MEDIAMUXER_H__ */

diff --git a/packaging/capi-mediamuxer.spec b/packaging/capi-mediamuxer.spec
index 336974e..bc1d0f5 100755 (executable)
--- a/packaging/capi-mediamuxer.spec
+++ b/packaging/capi-mediamuxer.spec
@@ -1,6 +1,6 @@
 Name:       capi-mediamuxer
 Summary:    A Media Muxer library in Tizen Native API
-Version:    0.1.13
+Version:    0.1.14
 Release:    1
 Group:      Multimedia/API
 License:    Apache-2.0