From 1e37a8cbae4a8d79f390ab393fdb9141e508b733 Mon Sep 17 00:00:00 2001
From: Sigmund Augdal Helberg <sigmunau@videolan.org>
Date: Fri, 18 Jun 2004 11:35:45 +0000
Subject: [PATCH] various documentation fixes

---
 include/variables.h                 | 2 +-
 src/playlist/info.c                 | 9 ++++-----
 src/playlist/item-ext.c             | 5 +++--
 src/playlist/item.c                 | 3 ++-
 src/video_output/vout_subpictures.c | 1 +
 5 files changed, 11 insertions(+), 9 deletions(-)

diff --git a/include/variables.h b/include/variables.h
index 210e14c62a..de6f94ec90 100644
--- a/include/variables.h
+++ b/include/variables.h
@@ -255,7 +255,7 @@ static inline int __var_SetInteger( vlc_object_t *p_obj, const char *psz_name, i
  *
  * \param p_obj The object that holds the variable
  * \param psz_name The name of the variable
- * \param i The new integer value of this variable
+ * \param b The new boolean value of this variable
  */
 static inline int __var_SetBool( vlc_object_t *p_obj, const char *psz_name, vlc_bool_t b )
 {
diff --git a/src/playlist/info.c b/src/playlist/info.c
index 73aaaae7b4..bd6ca2e5da 100644
--- a/src/playlist/info.c
+++ b/src/playlist/info.c
@@ -34,14 +34,14 @@
  * Must be entered with playlist lock
  *
  * \param p_playlist the playlist to get the info from
- * \param i_item position of the item on
- *               which we want the info ( -1 for current )
+ * \param i_pos position of the item on
+ *              which we want the info ( -1 for current )
  * \param psz_cat the category in which the info is stored
  * \param psz_name the name of the info
  * \return the info value if any, an empty string else
-*/
+ */
 char * playlist_GetInfo( playlist_t *p_playlist, int i_pos,
-                         const char * psz_cat, const char *psz_name )
+                         const char *psz_cat, const char *psz_name )
 {
     playlist_item_t *p_item;
     char *psz_buffer;
@@ -117,7 +117,6 @@ info_category_t * playlist_ItemGetCategory( playlist_item_t *p_item,
 /**
  * Create one info category for an item ( no p_playlist required )
  *
- * \param p_playlist the playlist
  * \param p_item the item to create category for
  * \param psz_cat the category we want to create
  * \return the info category.
diff --git a/src/playlist/item-ext.c b/src/playlist/item-ext.c
index 75c3dcdf40..8b3c3a3b44 100644
--- a/src/playlist/item-ext.c
+++ b/src/playlist/item-ext.c
@@ -152,7 +152,7 @@ playlist_item_t * playlist_ItemGetById( playlist_t * p_playlist , int i_id )
  * This function must be entered with the playlist lock
  *
  * \param p_playlist the playlist
- * \param i_id the id to find
+ * \param i_pos the position of the item to find
  * \return the item, or NULL on failure
  */
 playlist_item_t * playlist_ItemGetByPos( playlist_t * p_playlist , int i_pos )
@@ -181,6 +181,7 @@ playlist_item_t * playlist_ItemGetByPos( playlist_t * p_playlist , int i_pos )
  * Set the group of a playlist item
  *
  * \param p_item the item
+ * \param i_group the group to set
  * \return VLC_SUCCESS on success
  */
 int playlist_ItemSetGroup( playlist_item_t *p_item, int i_group)
@@ -281,7 +282,7 @@ int playlist_SetName( playlist_t *p_playlist, int i_pos, char *psz_name )
  * This function must be entered with the item lock
  *
  * \param p_item the item
- * \param psz_name the new name
+ * \param i_duration the new duration
  * \return VLC_SUCCESS on success, VLC_EGENERIC on failure
  */
 int playlist_ItemSetDuration( playlist_item_t *p_item, mtime_t i_duration )
diff --git a/src/playlist/item.c b/src/playlist/item.c
index 2a0225d098..984501e20c 100644
--- a/src/playlist/item.c
+++ b/src/playlist/item.c
@@ -32,6 +32,7 @@
 /**
  * Create a new item, without adding it to the playlist
  *
+ * \param p_obj a vlc object (anyone will do)
  * \param psz_uri the mrl of the item
  * \param psz_name a text giving a name or description of the item
  * \return the new item or NULL on failure
@@ -254,7 +255,7 @@ int playlist_AddItem( playlist_t *p_playlist, playlist_item_t *p_item,
  *  Add a option to one item ( no need for p_playlist )
  *
  * \param p_item the item on which we want the info
- * \param psz_format the option
+ * \param psz_option the option
  * \return 0 on success
  */
 int playlist_ItemAddOption( playlist_item_t *p_item, const char *psz_option )
diff --git a/src/video_output/vout_subpictures.c b/src/video_output/vout_subpictures.c
index aed96f7b0c..dc33d72bb8 100644
--- a/src/video_output/vout_subpictures.c
+++ b/src/video_output/vout_subpictures.c
@@ -79,6 +79,7 @@ void vout_DisplaySubPicture( vout_thread_t *p_vout, subpicture_t *p_subpic )
  * already allocated zone of memory in the spu data fields. It needs locking
  * since several pictures can be created by several producers threads.
  * \param p_vout the vout in which to create the subpicture
+ * \param i_channel the channel this subpicture should belong to
  * \param i_type the type of the subpicture
  * \return NULL on error, a reserved subpicture otherwise
  */