[vlc-commits] include: strings: consistently use \ for doxygen

Marvin Scholz git at videolan.org
Sat May 2 17:46:46 CEST 2020


vlc | branch: master | Marvin Scholz <epirat07 at gmail.com> | Tue Apr 14 19:11:40 2020 +0200| [32d61a7a653496df0c7c0e2e1b68abd5625bbc78] | committer: Alexandre Janniaux

include: strings: consistently use \ for doxygen

Signed-off-by: Alexandre Janniaux <ajanni at videolabs.io>

> http://git.videolan.org/gitweb.cgi/vlc.git/?a=commit;h=32d61a7a653496df0c7c0e2e1b68abd5625bbc78
---

 include/vlc_strings.h | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/include/vlc_strings.h b/include/vlc_strings.h
index 0b9a843f29..f467c87b40 100644
--- a/include/vlc_strings.h
+++ b/include/vlc_strings.h
@@ -163,8 +163,8 @@ VLC_API char * vlc_b64_decode( const char *psz_src );
  *
  * Formats the current time into a heap-allocated string.
  *
- * @param tformat time format (as with C strftime())
- * @return an allocated string (must be free()'d), or NULL on memory error.
+ * \param tformat time format (as with C strftime())
+ * \return an allocated string (must be free()'d), or NULL on memory error.
  */
 VLC_API char *vlc_strftime( const char * );
 
@@ -216,11 +216,11 @@ VLC_API char *vlc_strftime( const char * );
  * cause a replacement with nothing, when not available, instead of the placeholders
  * documented above.
  *
- * @param player a locked player instance or NULL (player and item can't be
+ * \param player a locked player instance or NULL (player and item can't be
  * both NULL)
- * @param item a valid item or NULL (player and item can't be both NULL)
- * @param fmt format string
- * @return an allocated formatted string (must be free()'d), or NULL in case of error
+ * \param item a valid item or NULL (player and item can't be both NULL)
+ * \param fmt format string
+ * \return an allocated formatted string (must be free()'d), or NULL in case of error
  */
 VLC_API char *vlc_strfplayer( vlc_player_t *player, input_item_t *item,
                               const char *fmt );



More information about the vlc-commits mailing list