Update of /cvsroot/gtkpod/libgpod/docs/reference/tmpl
In directory sc8-pr-cvs2.sourceforge.net:/tmp/cvs-serv29310/docs/reference/tmpl
Modified Files:
Internal.sgml artwork.sgml device.sgml itunesdb-copying.sgml
itunesdb-db.sgml itunesdb-lowlevel.sgml itunesdb-time.sgml
libgpod-unused.sgml playlists.sgml smart-playlists.sgml
track.sgml
Log Message:
applied Todd Zullinger's patch fixing warnings when building the documentation
Index: Internal.sgml
===================================================================
RCS file: /cvsroot/gtkpod/libgpod/docs/reference/tmpl/Internal.sgml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- Internal.sgml 10 Apr 2006 18:17:25 -0000 1.1
+++ Internal.sgml 10 Jan 2007 13:25:09 -0000 1.2
@@ -6,7 +6,7 @@
<!-- ##### SECTION Long_Description ##### -->
<para>
-
+These functions won't be documented because you won't be using them. ;)
</para>
<!-- ##### SECTION See_Also ##### -->
Index: artwork.sgml
===================================================================
RCS file: /cvsroot/gtkpod/libgpod/docs/reference/tmpl/artwork.sgml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -d -r1.6 -r1.7
--- artwork.sgml 8 Jan 2007 10:23:14 -0000 1.6
+++ artwork.sgml 10 Jan 2007 13:25:09 -0000 1.7
@@ -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 ##### -->
Index: device.sgml
===================================================================
RCS file: /cvsroot/gtkpod/libgpod/docs/reference/tmpl/device.sgml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -d -r1.6 -r1.7
--- device.sgml 8 Jan 2007 10:23:14 -0000 1.6
+++ device.sgml 10 Jan 2007 13:25:09 -0000 1.7
@@ -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 ##### -->
Index: itunesdb-copying.sgml
===================================================================
RCS file: /cvsroot/gtkpod/libgpod/docs/reference/tmpl/itunesdb-copying.sgml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- itunesdb-copying.sgml 10 Apr 2006 18:17:25 -0000 1.1
+++ itunesdb-copying.sgml 10 Jan 2007 13:25:09 -0000 1.2
@@ -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 ##### -->
Index: itunesdb-db.sgml
===================================================================
RCS file: /cvsroot/gtkpod/libgpod/docs/reference/tmpl/itunesdb-db.sgml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -d -r1.2 -r1.3
--- itunesdb-db.sgml 30 May 2006 14:09:41 -0000 1.2
+++ itunesdb-db.sgml 10 Jan 2007 13:25:09 -0000 1.3
@@ -6,7 +6,8 @@
<!-- ##### 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 ##### -->
Index: itunesdb-lowlevel.sgml
===================================================================
RCS file: /cvsroot/gtkpod/libgpod/docs/reference/tmpl/itunesdb-lowlevel.sgml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- itunesdb-lowlevel.sgml 10 Apr 2006 18:17:25 -0000 1.1
+++ itunesdb-lowlevel.sgml 10 Jan 2007 13:25:09 -0000 1.2
@@ -6,7 +6,8 @@
<!-- ##### 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 ##### -->
Index: itunesdb-time.sgml
===================================================================
RCS file: /cvsroot/gtkpod/libgpod/docs/reference/tmpl/itunesdb-time.sgml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- itunesdb-time.sgml 10 Apr 2006 18:17:25 -0000 1.1
+++ itunesdb-time.sgml 10 Jan 2007 13:25:09 -0000 1.2
@@ -6,7 +6,7 @@
<!-- ##### SECTION Long_Description ##### -->
<para>
-
+The functions provide conversion between Epoch time and Mac (iPod) time
</para>
<!-- ##### SECTION See_Also ##### -->
Index: libgpod-unused.sgml
===================================================================
RCS file: /cvsroot/gtkpod/libgpod/docs/reference/tmpl/libgpod-unused.sgml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -d -r1.2 -r1.3
--- libgpod-unused.sgml 4 Jun 2006 16:24:44 -0000 1.2
+++ libgpod-unused.sgml 10 Jan 2007 13:25:09 -0000 1.3
@@ -52,6 +52,31 @@
@FIFTH_GENERATION:
@MOBILE_GENERATION:
+<!-- ##### ENUM Itdb_IpodGeneration ##### -->
+<para>
+
+</para>
+
[EMAIL PROTECTED]:
[EMAIL PROTECTED]:
[EMAIL PROTECTED]:
[EMAIL PROTECTED]:
[EMAIL PROTECTED]:
[EMAIL PROTECTED]:
[EMAIL PROTECTED]:
[EMAIL PROTECTED]:
+
+<!-- ##### STRUCT Itdb_IpodInfo ##### -->
+<para>
+
+</para>
+
[EMAIL PROTECTED]:
[EMAIL PROTECTED]:
[EMAIL PROTECTED]:
[EMAIL PROTECTED]:
[EMAIL PROTECTED]:
+
<!-- ##### ENUM Itdb_ModelType ##### -->
<para>
@@ -153,6 +178,45 @@
</para>
+<!-- ##### FUNCTION itdb_artwork_add_thumbnail_from_data ##### -->
+<para>
+
+</para>
+
[EMAIL PROTECTED]:
[EMAIL PROTECTED]:
[EMAIL PROTECTED]:
[EMAIL PROTECTED]:
[EMAIL PROTECTED]:
[EMAIL PROTECTED]:
[EMAIL PROTECTED]:
+
+<!-- ##### FUNCTION itdb_device_get_ipod_info ##### -->
+<para>
+
+</para>
+
[EMAIL PROTECTED]:
[EMAIL PROTECTED]:
+
+<!-- ##### FUNCTION itdb_device_set_sysinfo ##### -->
+<para>
+
+</para>
+
[EMAIL PROTECTED]:
[EMAIL PROTECTED]:
[EMAIL PROTECTED]:
+
+<!-- ##### FUNCTION itdb_device_write_sysinfo ##### -->
+<para>
+
+</para>
+
[EMAIL PROTECTED]:
[EMAIL PROTECTED]:
[EMAIL PROTECTED]:
+
<!-- ##### FUNCTION itdb_file_error_quark ##### -->
<para>
@@ -160,3 +224,79 @@
@Returns:
+<!-- ##### FUNCTION itdb_get_itunessd_path ##### -->
+<para>
+
+</para>
+
[EMAIL PROTECTED]:
[EMAIL PROTECTED]:
+
+<!-- ##### FUNCTION itdb_get_photodb_path ##### -->
+<para>
+
+</para>
+
[EMAIL PROTECTED]:
[EMAIL PROTECTED]:
+
+<!-- ##### FUNCTION itdb_get_photos_dir ##### -->
+<para>
+
+</para>
+
[EMAIL PROTECTED]:
[EMAIL PROTECTED]:
+
+<!-- ##### FUNCTION itdb_get_photos_thumb_dir ##### -->
+<para>
+
+</para>
+
[EMAIL PROTECTED]:
[EMAIL PROTECTED]:
+
+<!-- ##### FUNCTION itdb_info_get_ipod_generation_string ##### -->
+<para>
+
+</para>
+
[EMAIL PROTECTED]:
[EMAIL PROTECTED]:
+
+<!-- ##### FUNCTION itdb_info_get_ipod_info_table ##### -->
+<para>
+
+</para>
+
[EMAIL PROTECTED]:
+
+<!-- ##### FUNCTION itdb_info_get_ipod_model_name_string ##### -->
+<para>
+
+</para>
+
[EMAIL PROTECTED]:
[EMAIL PROTECTED]:
+
+<!-- ##### FUNCTION itdb_init_ipod ##### -->
+<para>
+
+</para>
+
[EMAIL PROTECTED]:
[EMAIL PROTECTED]:
[EMAIL PROTECTED]:
[EMAIL PROTECTED]:
[EMAIL PROTECTED]:
+
+<!-- ##### FUNCTION itdb_track_set_thumbnails_from_data ##### -->
+<para>
+
+</para>
+
[EMAIL PROTECTED]:
[EMAIL PROTECTED]:
[EMAIL PROTECTED]:
[EMAIL PROTECTED]:
+
Index: playlists.sgml
===================================================================
RCS file: /cvsroot/gtkpod/libgpod/docs/reference/tmpl/playlists.sgml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -d -r1.2 -r1.3
--- playlists.sgml 8 Jan 2007 10:23:14 -0000 1.2
+++ playlists.sgml 10 Jan 2007 13:25:09 -0000 1.3
@@ -6,7 +6,9 @@
<!-- ##### 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 @@
@podcastflag:
@splpref:
@splrules:
[EMAIL PROTECTED]:
[EMAIL PROTECTED]:
@usertype:
@userdata:
@userdata_duplicate:
Index: smart-playlists.sgml
===================================================================
RCS file: /cvsroot/gtkpod/libgpod/docs/reference/tmpl/smart-playlists.sgml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- smart-playlists.sgml 10 Apr 2006 18:17:25 -0000 1.1
+++ smart-playlists.sgml 10 Jan 2007 13:25:09 -0000 1.2
@@ -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 ##### -->
Index: track.sgml
===================================================================
RCS file: /cvsroot/gtkpod/libgpod/docs/reference/tmpl/track.sgml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -d -r1.3 -r1.4
--- track.sgml 8 Jan 2007 10:23:14 -0000 1.3
+++ track.sgml 10 Jan 2007 13:25:09 -0000 1.4
@@ -6,7 +6,8 @@
<!-- ##### 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 @@
@podcastrss:
@chapterdata:
@subtitle:
[EMAIL PROTECTED]:
[EMAIL PROTECTED]:
[EMAIL PROTECTED]:
[EMAIL PROTECTED]:
[EMAIL PROTECTED]:
[EMAIL PROTECTED]:
@id:
@size:
@tracklen:
-------------------------------------------------------------------------
Take Surveys. Earn Cash. Influence the Future of IT
Join SourceForge.net's Techsay panel and you'll get the chance to share your
opinions on IT & business topics through brief surveys - and earn cash
http://www.techsay.com/default.php?page=join.php&p=sourceforge&CID=DEVDEV
_______________________________________________
gtkpod-cvs2 mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/gtkpod-cvs2
