Documentation: align parameter descriptions

8 files changed, 94 insertions, 92 deletions

diff --git a/src/itdb.h b/src/itdb.h
index 838798d..9903518 100644
--- a/src/itdb.h
+++ b/src/itdb.h
@@ -147,40 +147,40 @@ typedef enum {
 
 /**
  * Itdb_IpodModel:
- * @ITDB_IPOD_MODEL_INVALID: Invalid model
- * @ITDB_IPOD_MODEL_UNKNOWN: Unknown model
- * @ITDB_IPOD_MODEL_COLOR: Color iPod
- * @ITDB_IPOD_MODEL_COLOR_U2: Color iPod (U2)
- * @ITDB_IPOD_MODEL_REGULAR: Regular iPod
- * @ITDB_IPOD_MODEL_REGULAR_U2: Regular iPod (U2)
- * @ITDB_IPOD_MODEL_MINI: iPod Mini
- * @ITDB_IPOD_MODEL_MINI_BLUE: iPod Mini (Blue)
- * @ITDB_IPOD_MODEL_MINI_PINK: iPod Mini (Pink)
- * @ITDB_IPOD_MODEL_MINI_GREEN: iPod Mini (Green)
- * @ITDB_IPOD_MODEL_MINI_GOLD: iPod Mini (Gold)
- * @ITDB_IPOD_MODEL_SHUFFLE: iPod Shuffle
- * @ITDB_IPOD_MODEL_NANO_WHITE: iPod Nano (White)
- * @ITDB_IPOD_MODEL_NANO_BLACK: iPod Nano (Black)
- * @ITDB_IPOD_MODEL_VIDEO_WHITE: iPod Video (White)
- * @ITDB_IPOD_MODEL_VIDEO_BLACK: iPod Video (Black)
- * @ITDB_IPOD_MODEL_MOBILE_1: Mobile iPod
- * @ITDB_IPOD_MODEL_VIDEO_U2: iPod Video (U2)
- * @ITDB_IPOD_MODEL_NANO_SILVER: iPod Nano (Silver)
- * @ITDB_IPOD_MODEL_NANO_BLUE: iPod Nano (Blue)
- * @ITDB_IPOD_MODEL_NANO_GREEN: iPod Nano (Green)
- * @ITDB_IPOD_MODEL_NANO_PINK: iPod Nano (Pink)
- * @ITDB_IPOD_MODEL_NANO_RED: iPod Nano (Red)
- * @ITDB_IPOD_MODEL_IPHONE_1: iPhone
+ * @ITDB_IPOD_MODEL_INVALID:        Invalid model
+ * @ITDB_IPOD_MODEL_UNKNOWN:        Unknown model
+ * @ITDB_IPOD_MODEL_COLOR:          Color iPod
+ * @ITDB_IPOD_MODEL_COLOR_U2:       Color iPod (U2)
+ * @ITDB_IPOD_MODEL_REGULAR:        Regular iPod
+ * @ITDB_IPOD_MODEL_REGULAR_U2:     Regular iPod (U2)
+ * @ITDB_IPOD_MODEL_MINI:           iPod Mini
+ * @ITDB_IPOD_MODEL_MINI_BLUE:      iPod Mini (Blue)
+ * @ITDB_IPOD_MODEL_MINI_PINK:      iPod Mini (Pink)
+ * @ITDB_IPOD_MODEL_MINI_GREEN:     iPod Mini (Green)
+ * @ITDB_IPOD_MODEL_MINI_GOLD:      iPod Mini (Gold)
+ * @ITDB_IPOD_MODEL_SHUFFLE:        iPod Shuffle
+ * @ITDB_IPOD_MODEL_NANO_WHITE:     iPod Nano (White)
+ * @ITDB_IPOD_MODEL_NANO_BLACK:     iPod Nano (Black)
+ * @ITDB_IPOD_MODEL_VIDEO_WHITE:    iPod Video (White)
+ * @ITDB_IPOD_MODEL_VIDEO_BLACK:    iPod Video (Black)
+ * @ITDB_IPOD_MODEL_MOBILE_1:       Mobile iPod
+ * @ITDB_IPOD_MODEL_VIDEO_U2:       iPod Video (U2)
+ * @ITDB_IPOD_MODEL_NANO_SILVER:    iPod Nano (Silver)
+ * @ITDB_IPOD_MODEL_NANO_BLUE:      iPod Nano (Blue)
+ * @ITDB_IPOD_MODEL_NANO_GREEN:     iPod Nano (Green)
+ * @ITDB_IPOD_MODEL_NANO_PINK:      iPod Nano (Pink)
+ * @ITDB_IPOD_MODEL_NANO_RED:       iPod Nano (Red)
+ * @ITDB_IPOD_MODEL_IPHONE_1:       iPhone
  * @ITDB_IPOD_MODEL_SHUFFLE_SILVER: iPod Shuffle (Silver)
- * @ITDB_IPOD_MODEL_SHUFFLE_PINK: iPod Shuffle (Pink)
- * @ITDB_IPOD_MODEL_SHUFFLE_BLUE: iPod Shuffle (Blue)
- * @ITDB_IPOD_MODEL_SHUFFLE_GREEN: iPod Shuffle (Green)
+ * @ITDB_IPOD_MODEL_SHUFFLE_PINK:   iPod Shuffle (Pink)
+ * @ITDB_IPOD_MODEL_SHUFFLE_BLUE:   iPod Shuffle (Blue)
+ * @ITDB_IPOD_MODEL_SHUFFLE_GREEN:  iPod Shuffle (Green)
  * @ITDB_IPOD_MODEL_SHUFFLE_ORANGE: iPod Shuffle (Orange)
  * @ITDB_IPOD_MODEL_SHUFFLE_PURPLE: iPod Shuffle (Purple)
- * @ITDB_IPOD_MODEL_SHUFFLE_RED: iPod Shuffle (Red)
+ * @ITDB_IPOD_MODEL_SHUFFLE_RED:    iPod Shuffle (Red)
  * @ITDB_IPOD_MODEL_CLASSIC_SILVER: iPod Classic (Silver)
- * @ITDB_IPOD_MODEL_CLASSIC_BLACK: iPod Classic (Black)
- * @ITDB_IPOD_MODEL_TOUCH_BLACK: iPod Touch (Black)
+ * @ITDB_IPOD_MODEL_CLASSIC_BLACK:  iPod Classic (Black)
+ * @ITDB_IPOD_MODEL_TOUCH_BLACK:    iPod Touch (Black)
  *
  * iPod model information
  */
diff --git a/src/itdb_artwork.c b/src/itdb_artwork.c
index 00ed62d..09a5e9c 100644
--- a/src/itdb_artwork.c
+++ b/src/itdb_artwork.c
@@ -117,11 +117,11 @@ itdb_artwork_remove_thumbnails (Itdb_Artwork *artwork)
 
 /**
  * itdb_artwork_set_thumbnail
- * @artwork: an #Itdb_Artwork
- * @filename: image file to use to create the thumbnail
- * @rotation: angle by which the image should be rotated
- * counterclockwise. Valid values are 0, 90, 180 and 270.
- * @error: return location for a #GError or NULL
+ * @artwork:    an #Itdb_Artwork
+ * @filename:   image file to use to create the thumbnail
+ * @rotation:   angle by which the image should be rotated
+ *              counterclockwise. Valid values are 0, 90, 180 and 270.
+ * @error:      return location for a #GError or NULL
  *
  * Appends a thumbnail of type @type to existing thumbnails in @artwork. No
  * data is read from @filename yet, the file will be when @artwork is saved to
@@ -175,11 +175,11 @@ itdb_artwork_set_thumbnail (Itdb_Artwork *artwork,
 
 /**
  * itdb_artwork_set_thumbnail_from_pixbuf
- * @artwork: an #Itdb_Artwork
- * @pixbuf: #GdkPixbuf to use to create the thumbnail
- * @rotation: angle by which the image should be rotated
- * counterclockwise. Valid values are 0, 90, 180 and 270.
- * @error: return location for a #GError or NULL
+ * @artwork:    an #Itdb_Artwork
+ * @pixbuf:     #GdkPixbuf to use to create the thumbnail
+ * @rotation:   angle by which the image should be rotated
+ *              counterclockwise. Valid values are 0, 90, 180 and 270.
+ * @error:      return location for a #GError or NULL
  *
  * Set a thumbnail in @artwork. No data is generated from @pixbuf yet, it will
  * be done when @artwork is saved to disk. @pixbuf is ref'ed by this function,
@@ -233,13 +233,13 @@ itdb_artwork_set_thumbnail_from_pixbuf (Itdb_Artwork *artwork,
 
 /**
  * itdb_artwork_set_thumbnail_from_data
- * @artwork: an #Itdb_Artwork
- * @image_data: data used to create the thumbnail (the raw contents of
- *              an image file)
+ * @artwork:        an #Itdb_Artwork
+ * @image_data:     data used to create the thumbnail (the raw contents of
+ *                  an image file)
  * @image_data_len: length of above data block
- * @rotation: angle by which the image should be rotated
- * counterclockwise. Valid values are 0, 90, 180 and 270.
- * @error: return location for a #GError or NULL
+ * @rotation:       angle by which the image should be rotated
+ *                  counterclockwise. Valid values are 0, 90, 180 and 270.
+ * @error:          return location for a #GError or NULL
  *
  * Set a thumbnail in @artwork. No data is processed yet. This will be done when
  * @artwork is saved to disk.
@@ -879,12 +879,13 @@ gpointer itdb_thumb_ipod_item_to_pixbuf (Itdb_Device *device,
 
 /**
  * itdb_artwork_get_pixbuf:
- * @artwork: an #Itdb_Artwork
- * @device: an #Itdb_Device
- * @width: width of the pixbuf to retrieve, -1 for the biggest
- * possible size and 0 for the smallest possible size (with no scaling)
- * @height: height of the pixbuf to retrieve, -1 for the biggest possible size
- * and 0 for the smallest possible size (with no scaling)
+ * @artwork:    an #Itdb_Artwork
+ * @device:     an #Itdb_Device
+ * @width:      width of the pixbuf to retrieve, -1 for the biggest
+ *              possible size and 0 for the smallest possible size (with no
+ *              scaling)
+ * @height:     height of the pixbuf to retrieve, -1 for the biggest possible
+ *              size and 0 for the smallest possible size (with no scaling)
  *
  * Returns a #GdkPixbuf representing the thumbnail stored in @artwork
  * scaling it if appropriate. If either height or width is -1, then the
diff --git a/src/itdb_chapterdata.c b/src/itdb_chapterdata.c
index 77aa38c..c632ae0 100644
--- a/src/itdb_chapterdata.c
+++ b/src/itdb_chapterdata.c
@@ -116,7 +116,7 @@ Itdb_Chapterdata *itdb_chapterdata_duplicate (Itdb_Chapterdata *chapterdata)
 /**
  * itdb_chapterdata_remove_chapter:
  * @chapterdata: an #Itdb_Chapterdata
- * @chapter: an #Itdb_Chapter
+ * @chapter:     an #Itdb_Chapter
  *
  * Removes @chapter from @chapterdata. The memory used by @chapter is freed.
  **/
@@ -201,8 +201,8 @@ Itdb_Chapter *itdb_chapter_duplicate (Itdb_Chapter *chapter)
 
 /**
  * itdb_chapterdata_add_chapter
- * @chapterdata: an #Itdb_Chapterdata
- * @startpos: chapter start time in milliseconds
+ * @chapterdata:  an #Itdb_Chapterdata
+ * @startpos:     chapter start time in milliseconds
  * @chaptertitle: chapter title
  *
  * Appends a chapter to existing chapters in @chapterdata.
diff --git a/src/itdb_device.c b/src/itdb_device.c
index 6261711..fb4d519 100644
--- a/src/itdb_device.c
+++ b/src/itdb_device.c
@@ -684,7 +684,7 @@ void itdb_device_free (Itdb_Device *device)
 /**
  * itdb_device_set_mountpoint:
  * @device: an #Itdb_Device
- * @mp: the new mount point
+ * @mp:     the new mount point
  *
  * Sets the mountpoint of @device to @mp and update the cached device 
  * information (in particular, re-read the SysInfo file)
@@ -827,7 +827,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
+ * @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.
@@ -883,7 +883,7 @@ gboolean itdb_device_write_sysinfo (Itdb_Device *device, GError **error)
 /**
  * itdb_device_get_sysinfo:
  * @device: an #Itdb_Device
- * @field: field to retrive information from
+ * @field:  field to retrive information from
  *
  * Retrieve specified field from the SysInfo file.
  *
@@ -902,8 +902,8 @@ gchar *itdb_device_get_sysinfo (const Itdb_Device *device, const gchar *field)
 /**
  * itdb_device_set_sysinfo:
  * @device: an #Itdb_Device
- * @field: field to set
- * @value: value to set (or NULL to remove the field).
+ * @field:  field to set
+ * @value:  value to set (or NULL to remove the field).
  *
  * Set specified field. It can later be written to the iPod using
  * itdb_device_write_sysinfo()
@@ -1664,9 +1664,9 @@ G_GNUC_INTERNAL gboolean itdb_device_requires_checksum (Itdb_Device *device)
 /**
  * itdb_device_get_storage_info:
  *
- * @device: an #Itdb_Device
+ * @device:   an #Itdb_Device
  * @capacity: returned capacity in bytes
- * @free: returned free space in bytes
+ * @free:     returned free space in bytes
  *
  * Return the storage info for this iPod
  *
diff --git a/src/itdb_device.h b/src/itdb_device.h
index c2fdb07..41af762 100644
--- a/src/itdb_device.h
+++ b/src/itdb_device.h
@@ -76,16 +76,17 @@ enum _ItdbThumbFormat
 
 /**
  * Itdb_Device:
- * @mountpoint: The mountpoint of the iPod
- * @musicdirs: The number of /iPod_Control/Music/F.. dirs
- * @byte_order: G_LITTLE_ENDIAN "regular" endianness G_BIG_ENDIAN "reversed"
- * endianness (e.g. mobile phone iTunesDBs)
- * @sysinfo: A hash with key/value pairs of all entries in Device/SysInfo
- * @sysinfo_extended: The parsed content of SysInfoExtended, which can be NULL
- * @sysinfo_changed: True if the sysinfo hash been changed by the user, false
- * otherwise.  (see #itdb_set_sysinfo)
- * @timezone_shift: The difference in seconds between the current timezone and
- * UTC
+ * @mountpoint:         The mountpoint of the iPod
+ * @musicdirs:          The number of /iPod_Control/Music/F.. dirs
+ * @byte_order:         G_LITTLE_ENDIAN "regular" endianness G_BIG_ENDIAN
+ *                      "reversed" endianness (e.g. mobile phone iTunesDBs)
+ * @sysinfo:            A hash with key/value pairs of all entries in
+ *                      Device/SysInfo
+ * @sysinfo_extended:   The parsed content of SysInfoExtended, which can be NULL
+ * @sysinfo_changed:    True if the sysinfo hash been changed by the user, false
+ *                      otherwise.  (see #itdb_set_sysinfo)
+ * @timezone_shift:     The difference in seconds between the current timezone
+ *                      and UTC
  *
  * Structure representing an iPod device
  */
diff --git a/src/itdb_thumb.c b/src/itdb_thumb.c
index 3a5dba5..4eff766 100644
--- a/src/itdb_thumb.c
+++ b/src/itdb_thumb.c
@@ -300,7 +300,7 @@ Itdb_Thumb_Ipod_Item *itdb_thumb_ipod_get_item_by_type (Itdb_Thumb *thumbs,
 /**
  * itdb_thumb_ipod_get_filename:
  * @device: an #Itdb_Device
- * @thumb: an #Itdb_Thumb_Ipod_Item
+ * @thumb:  an #Itdb_Thumb_Ipod_Item
  *
  * Get filename of thumbnail. If it's a thumbnail on the iPod, return
  * the full path to the ithmb file. Otherwise return the full path to
@@ -356,9 +356,9 @@ const GList *itdb_thumb_ipod_get_thumbs (Itdb_Thumb_Ipod *thumbs)
 /**
  * itdb_thumb_to_pixbuf_at_size:
  * @device: an #Itdb_Device
- * @thumb: an #Itdb_Thumb
- * @width: width of the pixbuf to retrieve, -1 for the biggest
- *         possible size and 0 for the smallest possible size (with no scaling)
+ * @thumb:  an #Itdb_Thumb
+ * @width:  width of the pixbuf to retrieve, -1 for the biggest
+ *          possible size and 0 for the smallest possible size (with no scaling)
  * @height: height of the pixbuf to retrieve, -1 for the biggest possible size
  *          and 0 for the smallest possible size (with no scaling)
  *
@@ -527,7 +527,7 @@ static GList *itdb_thumb_ipod_to_pixbufs (Itdb_Device *device,
 /**
  * itdb_thumb_to_pixbufs:
  * @device: an #Itdb_Device
- * @thumb: an #Itdb_Thumb
+ * @thumb:  an #Itdb_Thumb
  *
  * Converts @thumb to a #GList of #GdkPixbuf. The returned #GList will
  * generally contain only 1 element, the full-size pixbuf associated with
diff --git a/src/itdb_thumb.h b/src/itdb_thumb.h
index 27c7fc6..695d06b 100644
--- a/src/itdb_thumb.h
+++ b/src/itdb_thumb.h
@@ -38,7 +38,7 @@ typedef enum {
 /**
  * Itdb_Thumb:
  * @data_type: an #ItdbThumbDataType
- * @rotation: angle by which the image is rotated counterclockwise
+ * @rotation:  angle by which the image is rotated counterclockwise
  *
  * The Itdb_Thumb structure can represent two slightly different
  * thumbnails:
diff --git a/src/itdb_track.c b/src/itdb_track.c
index 480c0bb..aabf89b 100644
--- a/src/itdb_track.c
+++ b/src/itdb_track.c
@@ -195,9 +195,9 @@ static void itdb_track_set_defaults (Itdb_Track *tr)
 
 /**
  * itdb_track_add:
- * @itdb: an #Itdb_iTunesDB
- * @track: an #Itdb_Track
- * @pos: position of the track to add
+ * @itdb:   an #Itdb_iTunesDB
+ * @track:  an #Itdb_Track
+ * @pos:    position of the track to add
  *
  * Adds @track to @itdb->tracks at position @pos (or at the end if pos
  * is -1). The application is responsible to also add it to the master
@@ -431,7 +431,7 @@ static gboolean itdb_track_set_thumbnails_internal (Itdb_Track *track,
 
 /**
  * itdb_track_set_thumbnails:
- * @track: an #Itdb_Track
+ * @track:    an #Itdb_Track
  * @filename: image file to use as a thumbnail
  *
  * Uses the image contained in @filename to generate iPod thumbnails. The image
@@ -453,9 +453,9 @@ gboolean itdb_track_set_thumbnails (Itdb_Track *track,
 
 /**
  * itdb_track_set_thumbnails_from_data:
- * @track: an #Itdb_Track
- * @image_data: data used to create the thumbnail (the raw contents of
- *              an image file)
+ * @track:          an #Itdb_Track
+ * @image_data:     data used to create the thumbnail (the raw contents of
+ *                  an image file)
  * @image_data_len: length of above data block
  *
  * Uses @image_data to generate iPod thumbnails. The image can be in
@@ -479,7 +479,7 @@ gboolean itdb_track_set_thumbnails_from_data (Itdb_Track *track,
 
 /**
  * itdb_track_set_thumbnails_from_pixbuf:
- * @track: an #Itdb_Track
+ * @track:  an #Itdb_Track
  * @pixbuf: a #GdkPixbuf used to generate the thumbnail
  *
  * Uses @pixbuf to generate iPod thumbnails. To save memory, the thumbnails
@@ -518,7 +518,7 @@ void itdb_track_remove_thumbnails (Itdb_Track *track)
 /**
  * itdb_track_by_id:
  * @itdb: an #Itdb_iTunesDB
- * @id: ID of the track to look for
+ * @id:   ID of the track to look for
  *
  * Looks up a track using its ID in @itdb.
  * Looking up tracks by ID is not really a good idea because the IDs
@@ -599,7 +599,7 @@ void itdb_track_id_tree_destroy (GTree *idtree)
 /**
  * itdb_track_id_tree_by_id:
  * @idtree: a #GTree created using itdb_track_id_tree_create()
- * @id: the ID of the track to search for
+ * @id:     the ID of the track to search for
  *
  * Lookup an #Itdb_Track by @id using @idtree for faster lookup (compared to
  * itdb_track_by_id)
@@ -630,11 +630,11 @@ gboolean itdb_track_has_thumbnails (Itdb_Track *track)
 
 /**
  * itdb_track_get_thumbnail:
- * @track: an #Itdb_Track
- * @width: width of the pixbuf to retrieve, -1 for the biggest possible size
- * (with no scaling)
+ * @track:  an #Itdb_Track
+ * @width:  width of the pixbuf to retrieve, -1 for the biggest possible size
+ *          (with no scaling)
  * @height: height of the pixbuf to retrieve, -1 for the biggest possible size
- * (with no scaling)
+ *          (with no scaling)
  *
  * Get a thumbnail representing the cover associated with the current track,
  * scaling it if appropriate. If either height or width is -1, then the biggest