[vlc-devel] [PATCH] vout: move the documentation in the header

[Steve Lhomme]

--
since it's a VLC_API entry
---
 include/vlc_vout.h              | 19 ++++++++++++++++++-
 src/video_output/video_output.c | 17 -----------------
 2 files changed, 18 insertions(+), 18 deletions(-)

diff --git a/include/vlc_vout.h b/include/vlc_vout.h
index 15f321d..50ef135 100644
--- a/include/vlc_vout.h
+++ b/include/vlc_vout.h
@@ -148,8 +148,25 @@ VLC_API int vout_GetSnapshot( vout_thread_t *p_vout,
 VLC_API void vout_ChangeAspectRatio( vout_thread_t *p_vout,
                                      unsigned int i_num, unsigned int i_den );
 
-/* */
+/**
+ * It retreives a picture from the vout or NULL if no pictures are
+ * available yet.
+ *
+ * You MUST call vout_PutPicture or picture_Release on it.
+ *
+ * You may use picture_Hold() (paired with picture_Release()) to keep a
+ * read-only reference.
+ */
 VLC_API picture_t * vout_GetPicture( vout_thread_t * );
+
+/**
+ * It gives to the vout a picture to be displayed.
+ *
+ * The given picture MUST comes from vout_GetPicture.
+ *
+ * Becareful, after vout_PutPicture is called, picture_t::p_next cannot be
+ * read/used.
+ */
 VLC_API void vout_PutPicture( vout_thread_t *, picture_t * );
 
 /* */
diff --git a/src/video_output/video_output.c b/src/video_output/video_output.c
index 43ff7ad..cd1fd60 100644
--- a/src/video_output/video_output.c
+++ b/src/video_output/video_output.c
@@ -397,15 +397,6 @@ void vout_FlushSubpictureChannel( vout_thread_t *vout, int channel )
                              channel);
 }
 
-/**
- * It retreives a picture from the vout or NULL if no pictures are
- * available yet.
- *
- * You MUST call vout_PutPicture or picture_Release on it.
- *
- * You may use picture_Hold() (paired with picture_Release()) to keep a
- * read-only reference.
- */
 picture_t *vout_GetPicture(vout_thread_t *vout)
 {
     picture_t *picture = picture_pool_Get(vout->p->decoder_pool);
@@ -417,14 +408,6 @@ picture_t *vout_GetPicture(vout_thread_t *vout)
     return picture;
 }
 
-/**
- * It gives to the vout a picture to be displayed.
- *
- * The given picture MUST comes from vout_GetPicture.
- *
- * Becareful, after vout_PutPicture is called, picture_t::p_next cannot be
- * read/used.
- */
 void vout_PutPicture(vout_thread_t *vout, picture_t *picture)
 {
     picture->p_next = NULL;
-- 
2.3.0