[MPlayer-dev-eng] [PATCH 4/5] Make doxygen comments consistent.

[Clément Bœsch]

---
 mplayer.c |   72 +++++++++++++++++++++++++-----------------------------------
 1 files changed, 30 insertions(+), 42 deletions(-)

diff --git a/mplayer.c b/mplayer.c
index 20ef389..2d1386d 100644
--- a/mplayer.c
+++ b/mplayer.c
@@ -1178,11 +1178,11 @@ void init_vo_spudec(void)
 }
 
 /**
- * \brief append a formatted string
- * \param buf buffer to print into
- * \param pos position of terminating 0 in buf
- * \param len maximum number of characters in buf, not including terminating 0
- * \param format printf format string
+ * @brief append a formatted string
+ * @param buf buffer to print into
+ * @param pos position of terminating 0 in buf
+ * @param len maximum number of characters in buf, not including terminating 0
+ * @param format printf format string
  */
 static void saddf(char *buf, unsigned *pos, int len, const char *format, ...)
 {
@@ -1197,11 +1197,11 @@ static void saddf(char *buf, unsigned *pos, int len, const char *format, ...)
 }
 
 /**
- * \brief append time in the hh:mm:ss.f format
- * \param buf buffer to print into
- * \param pos position of terminating 0 in buf
- * \param len maximum number of characters in buf, not including terminating 0
- * \param time time value to convert/append
+ * @brief append time in the hh:mm:ss.f format
+ * @param buf buffer to print into
+ * @param pos position of terminating 0 in buf
+ * @param len maximum number of characters in buf, not including terminating 0
+ * @param time time value to convert/append
  */
 static void sadd_hhmmssf(char *buf, unsigned *pos, int len, float time)
 {
@@ -1222,10 +1222,10 @@ static void sadd_hhmmssf(char *buf, unsigned *pos, int len, float time)
 }
 
 /**
- * \brief print the status line
- * \param a_pos audio position
- * \param a_v A-V desynchronization
- * \param corr amount out A-V synchronization
+ * @brief print the status line
+ * @param a_pos audio position
+ * @param a_v A-V desynchronization
+ * @param corr amount out A-V synchronization
  */
 static void print_status(float a_pos, float a_v, float corr)
 {
@@ -1316,10 +1316,10 @@ static void print_status(float a_pos, float a_v, float corr)
 }
 
 /**
- * \brief build a chain of audio filters that converts the input format
- * to the ao's format, taking into account the current playback_speed.
- * \param sh_audio describes the requested input format of the chain.
- * \param ao_data describes the requested output format of the chain.
+ * @brief build a chain of audio filters that converts the input format
+ *        to the ao's format, taking into account the current playback_speed.
+ * @param sh_audio describes the requested input format of the chain.
+ * @param ao_data describes the requested output format of the chain.
  */
 static int build_afilter_chain(sh_audio_t *sh_audio, ao_data_t *ao_data)
 {
@@ -1373,13 +1373,11 @@ struct mp_osd_msg {
 static mp_osd_msg_t *osd_msg_stack;
 
 /**
- *  \brief Add a message on the OSD message stack
- *
- *  If a message with the same id is already present in the stack
- *  it is pulled on top of the stack, otherwise a new message is created.
+ * @brief Add a message on the OSD message stack
  *
+ * If a message with the same id is already present in the stack
+ * it is pulled on top of the stack, otherwise a new message is created.
  */
-
 void set_osd_msg(int id, int level, int time, const char *fmt, ...)
 {
     mp_osd_msg_t *msg, *last = NULL;
@@ -1412,12 +1410,10 @@ void set_osd_msg(int id, int level, int time, const char *fmt, ...)
 }
 
 /**
- *  \brief Remove a message from the OSD stack
- *
- *  This function can be used to get rid of a message right away.
+ * @brief Remove a message from the OSD stack
  *
+ * This function can be used to get rid of a message right away.
  */
-
 void rm_osd_msg(int id)
 {
     mp_osd_msg_t *msg, *last = NULL;
@@ -1437,10 +1433,8 @@ void rm_osd_msg(int id)
 }
 
 /**
- *  \brief Remove all messages from the OSD stack
- *
+ * @brief Remove all messages from the OSD stack
  */
-
 static void clear_osd_msgs(void)
 {
     mp_osd_msg_t *msg = osd_msg_stack, *prev = NULL;
@@ -1453,13 +1447,11 @@ static void clear_osd_msgs(void)
 }
 
 /**
- *  \brief Get the current message from the OSD stack.
- *
- *  This function decrements the message timer and destroys the old ones.
- *  The message that should be displayed is returned (if any).
+ * @brief Get the current message from the OSD stack.
  *
+ * This function decrements the message timer and destroys the old ones.
+ * The message that should be displayed is returned (if any).
  */
-
 static mp_osd_msg_t *get_osd_msg(void)
 {
     mp_osd_msg_t *msg, *prev, *last = NULL;
@@ -1519,12 +1511,10 @@ static mp_osd_msg_t *get_osd_msg(void)
 }
 
 /**
- * \brief Display the OSD bar.
+ * @brief Display the OSD bar.
  *
  * Display the OSD bar or fall back on a simple message.
- *
  */
-
 void set_osd_bar(int type, const char *name, double min, double max, double val)
 {
     if (osd_level < 1)
@@ -1543,7 +1533,7 @@ void set_osd_bar(int type, const char *name, double min, double max, double val)
 }
 
 /**
- * \brief Display text subtitles on the OSD
+ * @brief Display text subtitles on the OSD
  */
 void set_osd_subtitle(subtitle *subs)
 {
@@ -1565,14 +1555,12 @@ void set_osd_subtitle(subtitle *subs)
 }
 
 /**
- * \brief Update the OSD message line.
+ * @brief Update the OSD message line.
  *
  * This function displays the current message on the vo OSD or on the term.
  * If the stack is empty and the OSD level is high enough the timer
  * is displayed (only on the vo OSD).
- *
  */
-
 static void update_osd_msg(void)
 {
     mp_osd_msg_t *msg;
-- 
1.7.4.4