[vlc-commits] vlc_common: don't use doc inline comments for defines

Thomas Guillem git at videolan.org
Fri Oct 19 12:09:57 CEST 2018


vlc | branch: master | Thomas Guillem <thomas at gllm.fr> | Fri Oct 19 12:02:30 2018 +0200| [8443136fd716d71688df7f94305ab1d478430be0] | committer: Thomas Guillem

vlc_common: don't use doc inline comments for defines

Otherwise, the comment is included on every doc that mention these defines.

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

 include/vlc_common.h | 27 ++++++++++++++++++---------
 1 file changed, 18 insertions(+), 9 deletions(-)

diff --git a/include/vlc_common.h b/include/vlc_common.h
index cfba55606e..060630ce50 100644
--- a/include/vlc_common.h
+++ b/include/vlc_common.h
@@ -467,15 +467,24 @@ typedef union
 /*****************************************************************************
  * Error values (shouldn't be exposed)
  *****************************************************************************/
-#define VLC_SUCCESS        (-0) /**< No error */
-#define VLC_EGENERIC       (-1) /**< Unspecified error */
-#define VLC_ENOMEM         (-2) /**< Not enough memory */
-#define VLC_ETIMEOUT       (-3) /**< Timeout */
-#define VLC_ENOMOD         (-4) /**< Module not found */
-#define VLC_ENOOBJ         (-5) /**< Object not found */
-#define VLC_ENOVAR         (-6) /**< Variable not found */
-#define VLC_EBADVAR        (-7) /**< Bad variable value */
-#define VLC_ENOITEM        (-8) /**< Item not found */
+/** No error */
+#define VLC_SUCCESS        (-0)
+/** Unspecified error */
+#define VLC_EGENERIC       (-1)
+/** Not enough memory */
+#define VLC_ENOMEM         (-2)
+/** Timeout */
+#define VLC_ETIMEOUT       (-3)
+/** Module not found */
+#define VLC_ENOMOD         (-4)
+/** Object not found */
+#define VLC_ENOOBJ         (-5)
+/** Variable not found */
+#define VLC_ENOVAR         (-6)
+/** Bad variable value */
+#define VLC_EBADVAR        (-7)
+/** Item not found */
+#define VLC_ENOITEM        (-8)
 
 /*****************************************************************************
  * Variable callbacks: called when the value is modified



More information about the vlc-commits mailing list