Minor documentation cleanups.

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

10 files changed, 77 insertions, 26 deletions

diff --git a/ChangeLog b/ChangeLog
index c944cbf..083de20 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,16 @@
+2007-05-12  Todd Zullinger <tmzullinger at users.sourceforge.net>
+
+	* docs/reference/Makefile.am
+	  docs/reference/libgpod-sections.txt
+	  docs/reference/tmpl/device.sgml
+	  docs/reference/tmpl/itunesdb-lowlevel.sgml
+	  docs/reference/tmpl/itunesdb-time.sgml
+	  docs/reference/tmpl/libgpod-unused.sgml
+	  docs/reference/tmpl/smart-playlists.sgml
+	  src/itdb_itunesdb.c
+	  src/itdb.h:
+	  Minor documentation cleanups.
+
 2007-05-10  Jorg Schuler <jcsjcs at users.sourceforge.net>
 
         * src/itdb_itunesdb.c: remove non-sense check (itdb != NULL) when
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
index cec7969..36a5720 100644
--- a/docs/reference/Makefile.am
+++ b/docs/reference/Makefile.am
@@ -25,7 +25,7 @@ SCANGOBJ_OPTIONS=
 
 # Extra options to supply to gtkdoc-scan.
 # e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED" 
-SCAN_OPTIONS=
+SCAN_OPTIONS=--deprecated-guards="LIBGPOD_DISABLE_DEPRECATED"
 
 # Extra options to supply to gtkdoc-mkdb.
 # e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
diff --git a/docs/reference/libgpod-sections.txt b/docs/reference/libgpod-sections.txt
index 62e2d40..e7aad15 100644
--- a/docs/reference/libgpod-sections.txt
+++ b/docs/reference/libgpod-sections.txt
@@ -48,6 +48,8 @@ itdb_resolve_path
 itdb_shuffle_write
 itdb_shuffle_write_file
 itdb_cp
+itdb_cp_get_dest_filename
+itdb_cp_finalize
 itdb_parse_file
 itdb_write_file
 itdb_duplicate
@@ -66,6 +68,7 @@ itdb_time_host_to_mac
 <TITLE>Tracks</TITLE>
 Itdb_Track
 Itdb_Mediatype
+ITDB_RATING_STEP
 itdb_track_new
 itdb_track_free
 itdb_track_add
@@ -80,7 +83,6 @@ itdb_track_set_thumbnails
 itdb_track_set_thumbnails_from_data
 itdb_track_set_thumbnails_from_pixbuf
 itdb_track_remove_thumbnails
-ITDB_RATING_STEP
 </SECTION>
 
 
@@ -131,8 +133,7 @@ ItdbSPLActionType
 ItdbSPLField
 ItdbSPLFieldType
 ItdbSPLMatch
-ITDB_SPLDATE_IDENTIFIER
-SPL_MAXSTRINGLENGTH
+ITDB_SPL_DATE_IDENTIFIER
 ITDB_SPL_STRING_MAXLEN
 itdb_splr_get_field_type
 itdb_splr_get_action_type
@@ -160,6 +161,8 @@ itdb_device_get_sysinfo
 itdb_device_set_sysinfo
 itdb_device_write_sysinfo
 itdb_device_get_ipod_info
+itdb_device_supports_artwork
+itdb_device_supports_photo
 itdb_info_get_ipod_info_table
 itdb_info_get_ipod_generation_string
 itdb_info_get_ipod_model_name_string
diff --git a/docs/reference/tmpl/device.sgml b/docs/reference/tmpl/device.sgml
index 9273deb..0a0cf82 100644
--- a/docs/reference/tmpl/device.sgml
+++ b/docs/reference/tmpl/device.sgml
@@ -102,6 +102,24 @@ These functions are for reading and setting information about the iPod.
 @Returns: 
 
 
+<!-- ##### FUNCTION itdb_device_supports_artwork ##### -->
+<para>
+
+</para>
+
+@device: 
+@Returns: 
+
+
+<!-- ##### FUNCTION itdb_device_supports_photo ##### -->
+<para>
+
+</para>
+
+@device: 
+@Returns: 
+
+
 <!-- ##### FUNCTION itdb_info_get_ipod_info_table ##### -->
 <para>
 
diff --git a/docs/reference/tmpl/itunesdb-lowlevel.sgml b/docs/reference/tmpl/itunesdb-lowlevel.sgml
index 5db32dd..9b8aaa8 100644
--- a/docs/reference/tmpl/itunesdb-lowlevel.sgml
+++ b/docs/reference/tmpl/itunesdb-lowlevel.sgml
@@ -169,6 +169,30 @@ control over the iPod database.
 @Returns: 
 
 
+<!-- ##### FUNCTION itdb_cp_get_dest_filename ##### -->
+<para>
+
+</para>
+
+@track: 
+@mountpoint: 
+@filename: 
+@error: 
+@Returns: 
+
+
+<!-- ##### FUNCTION itdb_cp_finalize ##### -->
+<para>
+
+</para>
+
+@track: 
+@mountpoint: 
+@dest_filename: 
+@error: 
+@Returns: 
+
+
 <!-- ##### FUNCTION itdb_parse_file ##### -->
 <para>
 
diff --git a/docs/reference/tmpl/itunesdb-time.sgml b/docs/reference/tmpl/itunesdb-time.sgml
index aeee4fb..59a75f5 100644
--- a/docs/reference/tmpl/itunesdb-time.sgml
+++ b/docs/reference/tmpl/itunesdb-time.sgml
@@ -33,7 +33,7 @@ databases
 
 </para>
 
-@time: 
+@mactime: 
 @Returns: 
 
 
diff --git a/docs/reference/tmpl/libgpod-unused.sgml b/docs/reference/tmpl/libgpod-unused.sgml
index 9749355..e4b24dd 100644
--- a/docs/reference/tmpl/libgpod-unused.sgml
+++ b/docs/reference/tmpl/libgpod-unused.sgml
@@ -315,22 +315,6 @@ iTunesDB
 </para>
 
 
-<!-- ##### FUNCTION itdb_device_supports_artwork ##### -->
-<para>
-
-</para>
-
-@device: 
-@Returns: 
-
-<!-- ##### FUNCTION itdb_device_supports_photo ##### -->
-<para>
-
-</para>
-
-@device: 
-@Returns: 
-
 <!-- ##### FUNCTION itdb_file_error_quark ##### -->
 <para>
 
diff --git a/docs/reference/tmpl/smart-playlists.sgml b/docs/reference/tmpl/smart-playlists.sgml
index 0fe0b18..e4e6422 100644
--- a/docs/reference/tmpl/smart-playlists.sgml
+++ b/docs/reference/tmpl/smart-playlists.sgml
@@ -208,6 +208,13 @@ These functions and structures are for dealing with smart playlists.
 @ITDB_SPLMATCH_AND: 
 @ITDB_SPLMATCH_OR: 
 
+<!-- ##### MACRO ITDB_SPL_DATE_IDENTIFIER ##### -->
+<para>
+
+</para>
+
+
+
 <!-- ##### MACRO ITDB_SPL_STRING_MAXLEN ##### -->
 <para>
 
diff --git a/src/itdb.h b/src/itdb.h
index 9a33bcb..6a1e64c 100644
--- a/src/itdb.h
+++ b/src/itdb.h
@@ -1195,10 +1195,12 @@ void itdb_thumb_free (Itdb_Thumb *thumb);
 Itdb_Thumb *itdb_thumb_new (void);
 gchar *itdb_thumb_get_filename (Itdb_Device *device, Itdb_Thumb *thumb);
 
+#ifndef LIBGPOD_DISABLE_DEPRECATED
 /* time functions */
 time_t itdb_time_get_mac_time (void);
 time_t itdb_time_mac_to_host (time_t time);
 time_t itdb_time_host_to_mac (time_t time);
+#endif
 
 /* Initialize a blank ipod */
 gboolean itdb_init_ipod (const gchar *mountpoint,
diff --git a/src/itdb_itunesdb.c b/src/itdb_itunesdb.c
index 7fd262b..c5a462a 100644
--- a/src/itdb_itunesdb.c
+++ b/src/itdb_itunesdb.c
@@ -6254,7 +6254,7 @@ time_t itdb_time_get_mac_time (void)
 
 /**
  * itdb_time_mac_to_host:
- * @mactime: time expressed in 'Mac' unit
+ * @time: time expressed in libgpod format
  *
  * Converts a timestamp from libgpod format to host system timestamp.
  *
@@ -6263,9 +6263,9 @@ time_t itdb_time_get_mac_time (void)
  * Deprecated: It's been kept for compatibility with older code, but this
  * function is now a no-op
  **/
-time_t itdb_time_mac_to_host (time_t mactime)
+time_t itdb_time_mac_to_host (time_t time)
 {
-    return mactime;
+    return time;
 }
 
 /**
@@ -6279,9 +6279,9 @@ time_t itdb_time_mac_to_host (time_t mactime)
  * Deprecated: It's been kept for compatibility with older code, but this
  * function is now a no-op
  **/
-time_t itdb_time_host_to_mac (time_t timet)
+time_t itdb_time_host_to_mac (time_t time)
 {
-    return timet;
+    return time;
 }
 
 time_t itdb_time_mac_to_time_t (Itdb_iTunesDB *db, guint64 mactime)