[vlc-devel] [PATCH 15/19] spu: move documentation to vlc_spu.h

[Kartik Ohri]

From: rustyc <amcap1712 at gmail.com>

Move documentation for VLC API method spu_Create and
spu_Destroy from src/video_output/vout_subpictures.c to
include/vlc_spu.h.
---
 include/vlc_spu.h                   | 13 ++++++++++++-
 src/video_output/vout_subpictures.c | 10 ----------
 2 files changed, 12 insertions(+), 11 deletions(-)

diff --git a/include/vlc_spu.h b/include/vlc_spu.h
index e4fb9a7ec1..7916eb946f 100644
--- a/include/vlc_spu.h
+++ b/include/vlc_spu.h
@@ -50,13 +50,24 @@ struct spu_t
     spu_private_t *p;
 };
 
+/**
+ * Creates the subpicture unit
+ *
+ * \param p_this the parent object which creates the subpicture unit
+ */
 VLC_API spu_t * spu_Create( vlc_object_t *, vout_thread_t * );
 #define spu_Create(a,b) spu_Create(VLC_OBJECT(a),b)
+
+/**
+ * Destroy the subpicture unit
+ *
+ * \param p_this the parent object which destroys the subpicture unit
+ */
 VLC_API void spu_Destroy( spu_t * );
 
 /**
  * This function sends a subpicture to the spu_t core.
- * 
+ *
  * You cannot use the provided subpicture anymore. The spu_t core
  * will destroy it at its convenience.
  */
diff --git a/src/video_output/vout_subpictures.c b/src/video_output/vout_subpictures.c
index 4c375e023d..e7f899576c 100644
--- a/src/video_output/vout_subpictures.c
+++ b/src/video_output/vout_subpictures.c
@@ -1603,11 +1603,6 @@ static void spu_Cleanup(spu_t *spu)
     video_format_Clean(&sys->prerender.fmtsrc);
 }
 
-/**
- * Destroy the subpicture unit
- *
- * \param p_this the parent object which destroys the subpicture unit
- */
 void spu_Destroy(spu_t *spu)
 {
     spu_private_t *sys = spu->p;
@@ -1623,11 +1618,6 @@ void spu_Destroy(spu_t *spu)
 }
 
 #undef spu_Create
-/**
- * Creates the subpicture unit
- *
- * \param p_this the parent object which creates the subpicture unit
- */
 spu_t *spu_Create(vlc_object_t *object, vout_thread_t *vout)
 {
     spu_t *spu = vlc_custom_create(object,
-- 
2.25.1