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

13 files changed, 186 insertions, 17 deletions

diff --git a/docs/reference/libgpod-docs.xml b/docs/reference/libgpod-docs.xml
index facff7b..bb66747 100644
--- a/docs/reference/libgpod-docs.xml
+++ b/docs/reference/libgpod-docs.xml
@@ -69,6 +69,7 @@
     <title>iPod database components</title>
     <xi:include href="xml/track.xml"/>
     <xi:include href="xml/playlists.xml"/>
+    <xi:include href="xml/smart-playlists.xml"/>
     <xi:include href="xml/artwork.xml"/>
     <xi:include href="xml/device.xml"/>
   </chapter>
diff --git a/docs/reference/libgpod-sections.txt b/docs/reference/libgpod-sections.txt
index 676f4d6..da8b518 100644
--- a/docs/reference/libgpod-sections.txt
+++ b/docs/reference/libgpod-sections.txt
@@ -36,8 +36,12 @@ itdb_get_itunes_dir
 itdb_get_music_dir
 itdb_get_artwork_dir
 itdb_get_device_dir
+itdb_get_photos_dir
 itdb_get_itunesdb_path
+itdb_get_itunessd_path
 itdb_get_artworkdb_path
+itdb_get_photodb_path
+itdb_get_photos_thumb_dir
 itdb_get_path
 
 itdb_resolve_path
@@ -72,6 +76,7 @@ itdb_track_id_tree_create
 itdb_track_id_tree_destroy
 itdb_track_id_tree_by_id
 itdb_track_set_thumbnails
+itdb_track_set_thumbnails_from_data
 itdb_track_remove_thumbnails
 ITDB_RATING_STEP
 </SECTION>
@@ -146,10 +151,17 @@ itdb_device_free
 itdb_device_set_mountpoint
 itdb_device_read_sysinfo
 itdb_device_get_sysinfo
+itdb_device_set_sysinfo
+itdb_device_write_sysinfo
+itdb_device_get_ipod_info
+itdb_info_get_ipod_info_table
+itdb_info_get_ipod_generation_string
+itdb_info_get_ipod_model_name_string
+itdb_init_ipod
+Itdb_IpodGeneration
+Itdb_IpodInfo
 Itdb_IpodModel
 Itdb_ArtworkFormat
-Itdb_Generation
-Itdb_ModelType
 </SECTION>
 
 <SECTION>
@@ -162,6 +174,7 @@ itdb_artwork_new
 itdb_artwork_duplicate
 itdb_artwork_free
 itdb_artwork_add_thumbnail
+itdb_artwork_add_thumbnail_from_data
 itdb_artwork_remove_thumbnail
 itdb_artwork_remove_thumbnails
 itdb_artwork_get_thumb_by_type
@@ -247,6 +260,7 @@ DB_TO_CPU_GET_DB
 ItdbFileError
 ITDB_FILE_ERROR
 itdb_file_error_quark
+itdb_get_artwork_info_from_type
 
 SPLACTION_LAST_HOURS_VALUE
 SPLACTION_LAST_MINUTES_VALUE
diff --git a/docs/reference/tmpl/Internal.sgml b/docs/reference/tmpl/Internal.sgml
index 5bae25a..d8a290a 100644
--- a/docs/reference/tmpl/Internal.sgml
+++ b/docs/reference/tmpl/Internal.sgml
@@ -6,7 +6,7 @@ Symbols to be hidden ;)
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
-
+These functions won't be documented because you won't be using them. ;)
 </para>
 
 <!-- ##### SECTION See_Also ##### -->
diff --git a/docs/reference/tmpl/artwork.sgml b/docs/reference/tmpl/artwork.sgml
index e2641b9..023b0e1 100644
--- a/docs/reference/tmpl/artwork.sgml
+++ b/docs/reference/tmpl/artwork.sgml
@@ -2,11 +2,11 @@
 Artwork
 
 <!-- ##### SECTION Short_Description ##### -->
-Data structure to store iPod artwork (cover and photos)
+Data structure to store iPod artwork (album covers and photos)
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
-
+These functions and structures are for adding, changing, and removing artwork.
 </para>
 
 <!-- ##### SECTION See_Also ##### -->
diff --git a/docs/reference/tmpl/device.sgml b/docs/reference/tmpl/device.sgml
index 6d25ee1..36d2778 100644
--- a/docs/reference/tmpl/device.sgml
+++ b/docs/reference/tmpl/device.sgml
@@ -2,11 +2,11 @@
 Device
 
 <!-- ##### SECTION Short_Description ##### -->
-Data structure holding information about the iPod (model, mount point, ...)
+Data structure holding information about the iPod (model, mount point, etc.)
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
-
+These functions are for reading and setting information about the iPod.
 </para>
 
 <!-- ##### SECTION See_Also ##### -->
diff --git a/docs/reference/tmpl/itunesdb-copying.sgml b/docs/reference/tmpl/itunesdb-copying.sgml
index 82bfe94..5b28c10 100644
--- a/docs/reference/tmpl/itunesdb-copying.sgml
+++ b/docs/reference/tmpl/itunesdb-copying.sgml
@@ -2,11 +2,12 @@
 File handling functions
 
 <!-- ##### SECTION Short_Description ##### -->
-Functions to copy new files to the iPod
+Managing files on the iPod
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
-
+These functions are for copying, renaming, and getting information about the
+files and directories on the iPod
 </para>
 
 <!-- ##### SECTION See_Also ##### -->
diff --git a/docs/reference/tmpl/itunesdb-db.sgml b/docs/reference/tmpl/itunesdb-db.sgml
index 6ec61bb..ef5db40 100644
--- a/docs/reference/tmpl/itunesdb-db.sgml
+++ b/docs/reference/tmpl/itunesdb-db.sgml
@@ -6,7 +6,8 @@ Functions to create, read, write the iPod database
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
-
+These functions are for creating, reading, writing, and deleting the iPod
+database and getting the total number of tracks and playlists.
 </para>
 
 <!-- ##### SECTION See_Also ##### -->
diff --git a/docs/reference/tmpl/itunesdb-lowlevel.sgml b/docs/reference/tmpl/itunesdb-lowlevel.sgml
index b91b65c..2f70b23 100644
--- a/docs/reference/tmpl/itunesdb-lowlevel.sgml
+++ b/docs/reference/tmpl/itunesdb-lowlevel.sgml
@@ -6,7 +6,8 @@ Low-level functions which shouldn't be needed in normal situations
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
-
+These functions are not normally needed but are avalable to allow for finer
+control over the iPod database.
 </para>
 
 <!-- ##### SECTION See_Also ##### -->
diff --git a/docs/reference/tmpl/itunesdb-time.sgml b/docs/reference/tmpl/itunesdb-time.sgml
index d06849e..3f75abb 100644
--- a/docs/reference/tmpl/itunesdb-time.sgml
+++ b/docs/reference/tmpl/itunesdb-time.sgml
@@ -6,7 +6,7 @@ Helper functions to convert between Epoch time and Mac (iPod) time
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
-
+The functions provide conversion between Epoch time and Mac (iPod) time
 </para>
 
 <!-- ##### SECTION See_Also ##### -->
diff --git a/docs/reference/tmpl/libgpod-unused.sgml b/docs/reference/tmpl/libgpod-unused.sgml
index aaf7c7f..7dfec86 100644
--- a/docs/reference/tmpl/libgpod-unused.sgml
+++ b/docs/reference/tmpl/libgpod-unused.sgml
@@ -52,6 +52,31 @@ iTunesDB
 @FIFTH_GENERATION: 
 @MOBILE_GENERATION: 
 
+<!-- ##### ENUM Itdb_IpodGeneration ##### -->
+<para>
+
+</para>
+
+@ITDB_IPOD_GENERATION_UNKNOWN: 
+@ITDB_IPOD_GENERATION_FIRST: 
+@ITDB_IPOD_GENERATION_SECOND: 
+@ITDB_IPOD_GENERATION_THIRD: 
+@ITDB_IPOD_GENERATION_FOURTH: 
+@ITDB_IPOD_GENERATION_FIFTH: 
+@ITDB_IPOD_GENERATION_SIXTH: 
+@ITDB_IPOD_GENERATION_MOBILE: 
+
+<!-- ##### STRUCT Itdb_IpodInfo ##### -->
+<para>
+
+</para>
+
+@model_number: 
+@capacity: 
+@ipod_model: 
+@ipod_generation: 
+@musicdirs: 
+
 <!-- ##### ENUM Itdb_ModelType ##### -->
 <para>
 
@@ -153,6 +178,45 @@ iTunesDB
 </para>
 
 
+<!-- ##### FUNCTION itdb_artwork_add_thumbnail_from_data ##### -->
+<para>
+
+</para>
+
+@artwork: 
+@type: 
+@image_data: 
+@image_data_len: 
+@rotation: 
+@error: 
+@Returns: 
+
+<!-- ##### FUNCTION itdb_device_get_ipod_info ##### -->
+<para>
+
+</para>
+
+@device: 
+@Returns: 
+
+<!-- ##### FUNCTION itdb_device_set_sysinfo ##### -->
+<para>
+
+</para>
+
+@device: 
+@field: 
+@value: 
+
+<!-- ##### FUNCTION itdb_device_write_sysinfo ##### -->
+<para>
+
+</para>
+
+@device: 
+@error: 
+@Returns: 
+
 <!-- ##### FUNCTION itdb_file_error_quark ##### -->
 <para>
 
@@ -160,3 +224,79 @@ iTunesDB
 
 @Returns: 
 
+<!-- ##### FUNCTION itdb_get_itunessd_path ##### -->
+<para>
+
+</para>
+
+@mountpoint: 
+@Returns: 
+
+<!-- ##### FUNCTION itdb_get_photodb_path ##### -->
+<para>
+
+</para>
+
+@mountpoint: 
+@Returns: 
+
+<!-- ##### FUNCTION itdb_get_photos_dir ##### -->
+<para>
+
+</para>
+
+@mountpoint: 
+@Returns: 
+
+<!-- ##### FUNCTION itdb_get_photos_thumb_dir ##### -->
+<para>
+
+</para>
+
+@mountpoint: 
+@Returns: 
+
+<!-- ##### FUNCTION itdb_info_get_ipod_generation_string ##### -->
+<para>
+
+</para>
+
+@generation: 
+@Returns: 
+
+<!-- ##### FUNCTION itdb_info_get_ipod_info_table ##### -->
+<para>
+
+</para>
+
+@Returns: 
+
+<!-- ##### FUNCTION itdb_info_get_ipod_model_name_string ##### -->
+<para>
+
+</para>
+
+@model: 
+@Returns: 
+
+<!-- ##### FUNCTION itdb_init_ipod ##### -->
+<para>
+
+</para>
+
+@mountpoint: 
+@model_number: 
+@ipod_name: 
+@error: 
+@Returns: 
+
+<!-- ##### FUNCTION itdb_track_set_thumbnails_from_data ##### -->
+<para>
+
+</para>
+
+@track: 
+@image_data: 
+@image_data_len: 
+@Returns: 
+
diff --git a/docs/reference/tmpl/playlists.sgml b/docs/reference/tmpl/playlists.sgml
index 2d69676..c40a238 100644
--- a/docs/reference/tmpl/playlists.sgml
+++ b/docs/reference/tmpl/playlists.sgml
@@ -6,7 +6,9 @@ Data structure to represent an iPod playlist
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
-
+These functions and structures allow for adding and removing playlists,
+adding and removing tracks from playlists, sorting playlists, finding tracks in
+a playlist, etc.
 </para>
 
 <!-- ##### SECTION See_Also ##### -->
@@ -37,6 +39,8 @@ Data structure to represent an iPod playlist
 @podcastflag: 
 @splpref: 
 @splrules: 
+@reserved1: 
+@reserved2: 
 @usertype: 
 @userdata: 
 @userdata_duplicate: 
diff --git a/docs/reference/tmpl/smart-playlists.sgml b/docs/reference/tmpl/smart-playlists.sgml
index d910ccd..2d1d540 100644
--- a/docs/reference/tmpl/smart-playlists.sgml
+++ b/docs/reference/tmpl/smart-playlists.sgml
@@ -2,16 +2,16 @@
 Smart Playlists
 
 <!-- ##### SECTION Short_Description ##### -->
-Data structures used to manipulate iPod smart playlists
+Data structure to represent an iPod smart playlist
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
-
+These functions and structures are for dealing with smart playlists.
 </para>
 
 <!-- ##### SECTION See_Also ##### -->
 <para>
-
+<link linkend="libgpod-Playlists">Playlists</link>
 </para>
 
 <!-- ##### SECTION Stability_Level ##### -->
diff --git a/docs/reference/tmpl/track.sgml b/docs/reference/tmpl/track.sgml
index b10d81c..8ec4980 100644
--- a/docs/reference/tmpl/track.sgml
+++ b/docs/reference/tmpl/track.sgml
@@ -6,7 +6,8 @@ Data structure to store metadata about an iPod track
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
-
+These functions and structures are for storing and retrieving
+information about an iPod track.
 </para>
 
 <!-- ##### SECTION See_Also ##### -->
@@ -38,6 +39,12 @@ Data structure to store metadata about an iPod track
 @podcastrss: 
 @chapterdata: 
 @subtitle: 
+@tvshow: 
+@tvepisode: 
+@tvnetwork: 
+@albumartist: 
+@keywords: 
+@reserved: 
 @id: 
 @size: 
 @tracklen: