[vlc-devel] [PATCH 09/19] meta: move documentation to vlc_meta.h

[Kartik Ohri]

From: rustyc <amcap1712 at gmail.com>

Move documentation for VLC API methods vlc_meta_New,
vlc_meta_Set, vlc_meta_GetStatus and vlc_meta_Merge from
src/input/meta.c to include/vlc_meta.h.
---
 include/vlc_meta.h | 16 ++++++++++++++++
 src/input/meta.c   | 16 ----------------
 2 files changed, 16 insertions(+), 16 deletions(-)

diff --git a/include/vlc_meta.h b/include/vlc_meta.h
index 897d227a81..a64f8ffe02 100644
--- a/include/vlc_meta.h
+++ b/include/vlc_meta.h
@@ -71,8 +71,18 @@ typedef enum vlc_meta_type_t
  */
 struct vlc_meta_t;
 
+/**
+ * vlc_meta contructor.
+ * vlc_meta_Delete() will free the returned pointer.
+ */
 VLC_API vlc_meta_t * vlc_meta_New( void ) VLC_USED;
 VLC_API void vlc_meta_Delete( vlc_meta_t *m );
+
+/**
+ * vlc_meta has two kinds of meta, the one in a table, and the one in a
+ * dictionary.
+ * FIXME - Why don't we merge those two?
+ */
 VLC_API void vlc_meta_Set( vlc_meta_t *p_meta, vlc_meta_type_t meta_type, const char *psz_val );
 VLC_API const char * vlc_meta_Get( const vlc_meta_t *p_meta, vlc_meta_type_t meta_type );
 
@@ -86,8 +96,14 @@ VLC_API unsigned vlc_meta_GetExtraCount( const vlc_meta_t *m );
  */
 VLC_API char ** vlc_meta_CopyExtraNames( const vlc_meta_t *m ) VLC_USED;
 
+/**
+ * Merging meta
+ */
 VLC_API void vlc_meta_Merge( vlc_meta_t *dst, const vlc_meta_t *src );
 
+/**
+ * vlc_meta status (see vlc_meta_status_e)
+ */
 VLC_API int vlc_meta_GetStatus( vlc_meta_t *m );
 VLC_API void vlc_meta_SetStatus( vlc_meta_t *m, int status );
 
diff --git a/src/input/meta.c b/src/input/meta.c
index e5d829222f..ae6119f522 100644
--- a/src/input/meta.c
+++ b/src/input/meta.c
@@ -83,10 +83,6 @@ const char * vlc_meta_TypeToLocalizedString( vlc_meta_type_t meta_type )
 };
 
 
-/**
- * vlc_meta contructor.
- * vlc_meta_Delete() will free the returned pointer.
- */
 vlc_meta_t *vlc_meta_New( void )
 {
     vlc_meta_t *m = (vlc_meta_t*)malloc( sizeof(*m) );
@@ -113,12 +109,6 @@ void vlc_meta_Delete( vlc_meta_t *m )
     free( m );
 }
 
-/**
- * vlc_meta has two kinds of meta, the one in a table, and the one in a
- * dictionary.
- * FIXME - Why don't we merge those two?
- */
-
 void vlc_meta_Set( vlc_meta_t *p_meta, vlc_meta_type_t meta_type, const char *psz_val )
 {
     free( p_meta->ppsz_meta[meta_type] );
@@ -155,9 +145,6 @@ char** vlc_meta_CopyExtraNames( const vlc_meta_t *m )
     return vlc_dictionary_all_keys(&m->extra_tags);
 }
 
-/**
- * vlc_meta status (see vlc_meta_status_e)
- */
 int vlc_meta_GetStatus( vlc_meta_t *m )
 {
     return m->i_status;
@@ -169,9 +156,6 @@ void vlc_meta_SetStatus( vlc_meta_t *m, int status )
 }
 
 
-/**
- * Merging meta
- */
 void vlc_meta_Merge( vlc_meta_t *dst, const vlc_meta_t *src )
 {
     if( !dst || !src )
-- 
2.25.1