[vlc-commits] Move the VLC_FORWARD_DECLARE_OBJECT definition above the doxygen comment
Olivier Aubert
git at videolan.org
Wed Jan 9 16:12:35 CET 2013
vlc | branch: master | Olivier Aubert <olivier.aubert at liris.cnrs.fr> | Wed Jan 9 16:12:30 2013 +0100| [38156fee9697522a587c67e2389b0ae91e391c10] | committer: Olivier Aubert
Move the VLC_FORWARD_DECLARE_OBJECT definition above the doxygen comment
Putting it between the libvlc_media_subitems comment and the function
definition messes parsing by doxygen and by the python module generator.
> http://git.videolan.org/gitweb.cgi/vlc.git/?a=commit;h=38156fee9697522a587c67e2389b0ae91e391c10
---
include/vlc/libvlc_media.h | 9 ++++-----
1 file changed, 4 insertions(+), 5 deletions(-)
diff --git a/include/vlc/libvlc_media.h b/include/vlc/libvlc_media.h
index 0489e7d..7e61039 100644
--- a/include/vlc/libvlc_media.h
+++ b/include/vlc/libvlc_media.h
@@ -394,6 +394,10 @@ LIBVLC_API libvlc_state_t libvlc_media_get_state(
LIBVLC_API int libvlc_media_get_stats( libvlc_media_t *p_md,
libvlc_media_stats_t *p_stats );
+/* The following method uses libvlc_media_list_t, however, media_list usage is optionnal
+ * and this is here for convenience */
+#define VLC_FORWARD_DECLARE_OBJECT(a) struct a
+
/**
* Get subitems of media descriptor object. This will increment
* the reference count of supplied media descriptor object. Use
@@ -402,11 +406,6 @@ LIBVLC_API int libvlc_media_get_stats( libvlc_media_t *p_md,
* \param p_md media descriptor object
* \return list of media descriptor subitems or NULL
*/
-
-/* This method uses libvlc_media_list_t, however, media_list usage is optionnal
- * and this is here for convenience */
-#define VLC_FORWARD_DECLARE_OBJECT(a) struct a
-
LIBVLC_API VLC_FORWARD_DECLARE_OBJECT(libvlc_media_list_t *)
libvlc_media_subitems( libvlc_media_t *p_md );
More information about the vlc-commits
mailing list