[vlc-devel] [PATCH 07/19] interface: move documentation to vlc_interface.h

[Kartik Ohri]

From: rustyc <amcap1712 at gmail.com>

Move documentation for VLC API methods intf_Create from
src/interface/interface.c, libvlc_Quit from src/misc/exit.c
and vlc_LogSet from src/misc/messages.c to
include/vlc_interface.h.
---
 include/vlc_interface.h   | 16 ++++++++++++++++
 src/interface/interface.c |  7 -------
 src/misc/exit.c           |  4 ----
 src/misc/messages.c       |  5 -----
 4 files changed, 16 insertions(+), 16 deletions(-)

diff --git a/include/vlc_interface.h b/include/vlc_interface.h
index 021314c37b..c328ad3d61 100644
--- a/include/vlc_interface.h
+++ b/include/vlc_interface.h
@@ -87,8 +87,19 @@ struct intf_dialog_args_t
     struct interaction_dialog_t *p_dialog;
 };
 
+/**
+ * Create and start an interface.
+ *
+ * @param playlist playlist and parent object for the interface
+ * @param chain configuration chain string
+ * @return VLC_SUCCESS or an error code
+ */
 VLC_API int intf_Create( libvlc_int_t *, const char * );
 
+/**
+ * Posts an exit signal to LibVLC instance.
+ * This function should only be called on behalf of the user.
+ */
 VLC_API void libvlc_Quit( libvlc_int_t * );
 
 /**
@@ -104,6 +115,11 @@ vlc_intf_GetMainPlaylist(intf_thread_t *intf);
  * @{
  */
 
+/**
+ * Sets the message logging callback.
+ * \param ops message callback, or NULL to clear
+ * \param data data pointer for the message callback
+ */
 VLC_API void vlc_LogSet(libvlc_int_t *, const struct vlc_logger_operations *,
                         void *data);
 
diff --git a/src/interface/interface.c b/src/interface/interface.c
index cc490a35f2..0ea17de8f6 100644
--- a/src/interface/interface.c
+++ b/src/interface/interface.c
@@ -121,13 +121,6 @@ vlc_intf_GetMainPlaylist(intf_thread_t *intf)
     return pl;
 }
 
-/**
- * Create and start an interface.
- *
- * @param playlist playlist and parent object for the interface
- * @param chain configuration chain string
- * @return VLC_SUCCESS or an error code
- */
 int intf_Create( libvlc_int_t *libvlc, const char *chain )
 {
     assert( libvlc );
diff --git a/src/misc/exit.c b/src/misc/exit.c
index d6cb0ad407..a30f82680c 100644
--- a/src/misc/exit.c
+++ b/src/misc/exit.c
@@ -48,10 +48,6 @@ void libvlc_SetExitHandler( libvlc_int_t *p_libvlc, void (*handler) (void *),
     vlc_mutex_unlock( &exit->lock );
 }
 
-/**
- * Posts an exit signal to LibVLC instance.
- * This function should only be called on behalf of the user.
- */
 void libvlc_Quit( libvlc_int_t *p_libvlc )
 {
     vlc_exit_t *exit = &libvlc_priv( p_libvlc )->exit;
diff --git a/src/misc/messages.c b/src/misc/messages.c
index 898e4be56f..edf44f248d 100644
--- a/src/misc/messages.c
+++ b/src/misc/messages.c
@@ -561,11 +561,6 @@ vlc_LogExternalCreate(const struct vlc_logger_operations *ops, void *opaque)
     return &ext->logger;
 }
 
-/**
- * Sets the message logging callback.
- * \param ops message callback, or NULL to clear
- * \param data data pointer for the message callback
- */
 void vlc_LogSet(libvlc_int_t *vlc, const struct vlc_logger_operations *ops,
                 void *opaque)
 {
-- 
2.25.1