applied Todd Zullinger's patch fixing warnings when building the documentation

git-svn-id: https://gtkpod.svn.sf.net/svnroot/gtkpod/libgpod/trunk@1355 f01d2545-417e-4e96-918e-98f8d0dbbcb6

4 files changed, 12 insertions, 6 deletions

diff --git a/src/itdb.h b/src/itdb.h
index 04b5f22..66bbcac 100644
--- a/src/itdb.h
+++ b/src/itdb.h
@@ -893,7 +893,7 @@ GQuark     itdb_file_error_quark      (void);
 /* functions for reading/writing database, general itdb functions */
 Itdb_iTunesDB *itdb_parse (const gchar *mp, GError **error);
 Itdb_iTunesDB *itdb_parse_file (const gchar *filename, GError **error);
-gboolean itdb_write (Itdb_iTunesDB *db, GError **error);
+gboolean itdb_write (Itdb_iTunesDB *itdb, GError **error);
 gboolean itdb_write_file (Itdb_iTunesDB *itdb, const gchar *filename,
 			  GError **error);
 gboolean itdb_shuffle_write (Itdb_iTunesDB *itdb, GError **error);
diff --git a/src/itdb_device.c b/src/itdb_device.c
index a0f746b..a66a2bc 100644
--- a/src/itdb_device.c
+++ b/src/itdb_device.c
@@ -413,6 +413,7 @@ static void write_sysinfo_entry (const gchar *key,
 /** 
  * itdb_device_write_sysinfo:
  * @device: an #Itdb_Device
+ * @error: return location for a #GError or NULL
  *
  * Fills the SysInfo file with information in device->sysinfo. Note:
  * no directories are created if not already existent.
@@ -733,7 +734,8 @@ const Itdb_IpodInfo *itdb_info_get_ipod_info_table (void)
 
 
 /**
- * itdb_info_get_ipod_model_string:
+ * itdb_info_get_ipod_model_name_string:
+ * @model: an #Itdb_IpodModel
  *
  * Return the iPod's generic model name, like "Color", "Nano"...
  *
@@ -757,6 +759,7 @@ const gchar *itdb_info_get_ipod_model_name_string (Itdb_IpodModel model)
 
 /**
  * itdb_info_get_ipod_generation_string:
+ * @generation: an #Itdb_IpodGeneration
  *
  * Return the iPod's generic generation name, like "First Generation",
  * "Mobile Phone"...
diff --git a/src/itdb_itunesdb.c b/src/itdb_itunesdb.c
index f4699c3..14d4344 100644
--- a/src/itdb_itunesdb.c
+++ b/src/itdb_itunesdb.c
@@ -287,11 +287,15 @@ static void fcontents_free (FContents *cts)
  * @root: in local encoding
  * @components: in utf8
  *
+ * Resolve the path to a track on the iPod
+ *
  * We start by assuming that the ipod mount point exists.  Then, for
  * each component c of track->ipod_path, we try to find an entry d in
  * good_path that is case-insensitively equal to c.  If we find d, we
  * append d to good_path and make the result the new good_path.
  * Otherwise, we quit and return NULL.
+ *
+ * Return value: path to track on the iPod or NULL.
  **/
 gchar * itdb_resolve_path (const gchar *root,
 			   const gchar * const * components)
@@ -5577,9 +5581,9 @@ guint64 itdb_time_host_to_mac (time_t time)
  * itdb_init_ipod:
  * @mountpoint:   the iPod mountpoint
  * @model_number: the iPod model number
- * @model_type:   the type of iPod, eg. regular, shuffle
  * @ipod_name:    the name to give to the iPod. Will be displayed in
  *                gtkpod or itunes
+ * @error:        return location for a #GError or NULL
  *
  * Initialise an iPod device from scratch. The function attempts to
  * create a blank database, complete with master playlist and device
diff --git a/src/itdb_photoalbum.c b/src/itdb_photoalbum.c
index 04db6b2..3fd10c7 100644
--- a/src/itdb_photoalbum.c
+++ b/src/itdb_photoalbum.c
@@ -578,13 +578,12 @@ void itdb_photodb_remove_photo (Itdb_PhotoDB *db,
 
 /**
  * itdb_photodb_photoalbum_by_name:
- * Return a pointer to the first photoalbum named @albumname
- *
  * @db: the #Itdb_PhotoDB to retrieve the album from
  * @albumname: the name of the photoalbum to get or NULL for the
  * master photoalbum.
  *
- * Returns the photoalbum if found, else NULL
+ * Return value: a pointer to the first photoalbum named @albumname,
+ * else NULL
  */
 Itdb_PhotoAlbum *itdb_photodb_photoalbum_by_name (Itdb_PhotoDB *db, const gchar *albumname)
 {