summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTodd Zullinger <tmz@pobox.com>2008-08-08 00:56:03 -0400
committerTodd Zullinger <tmz@pobox.com>2008-11-14 12:14:45 -0500
commita273e1e8217ddb97e690abcaa3c4834916aeb5b7 (patch)
tree98474839b3f81ddb2d35f3fd619017f3a4fbd22d
parentae3851301e71ac02e50ee88740b9b22b19e4fbd9 (diff)
downloadlibgpod-tmz-a273e1e8217ddb97e690abcaa3c4834916aeb5b7.tar.gz
libgpod-tmz-a273e1e8217ddb97e690abcaa3c4834916aeb5b7.tar.xz
libgpod-tmz-a273e1e8217ddb97e690abcaa3c4834916aeb5b7.zip
Documentation: re-organize photodb section
-rw-r--r--docs/reference/libgpod-sections.txt16
-rw-r--r--docs/reference/tmpl/photodb.sgml136
2 files changed, 77 insertions, 75 deletions
diff --git a/docs/reference/libgpod-sections.txt b/docs/reference/libgpod-sections.txt
index 88f5745..0db7680 100644
--- a/docs/reference/libgpod-sections.txt
+++ b/docs/reference/libgpod-sections.txt
@@ -218,19 +218,21 @@ itdb_thumb_to_pixbufs
<FILE>photodb</FILE>
<TITLE>Photo database</TITLE>
Itdb_PhotoDB
-Itdb_PhotoAlbum
-itdb_photodb_add_photo
-itdb_photodb_add_photo_from_data
-itdb_photodb_add_photo_from_pixbuf
itdb_photodb_create
itdb_photodb_free
itdb_photodb_parse
+itdb_photodb_write
+
+itdb_photodb_add_photo
+itdb_photodb_add_photo_from_data
+itdb_photodb_add_photo_from_pixbuf
+itdb_photodb_remove_photo
+
+Itdb_PhotoAlbum
+itdb_photodb_photoalbum_create
itdb_photodb_photoalbum_add_photo
itdb_photodb_photoalbum_by_name
-itdb_photodb_photoalbum_create
itdb_photodb_photoalbum_remove
-itdb_photodb_remove_photo
-itdb_photodb_write
</SECTION>
<SECTION>
diff --git a/docs/reference/tmpl/photodb.sgml b/docs/reference/tmpl/photodb.sgml
index 1d53086..08e307d 100644
--- a/docs/reference/tmpl/photodb.sgml
+++ b/docs/reference/tmpl/photodb.sgml
@@ -59,11 +59,11 @@ Library Album if called with no name.
</para>
<para>
If you cannot add photos because your iPod is not recognized,
-you may have to set the iPod model by calling
+you may have to set the iPod model by calling:
</para>
-<para>
+<programlisting>
itdb_device_set_sysinfo (db->device, "ModelNumStr", model);
-</para>
+</programlisting>
<para>
For example, "MA450" would stand for an 80 GB 6th generation iPod Video. See
<ulink type="http"
@@ -107,37 +107,42 @@ directory of the libgpod source for an example of how to use the interface.
@userdata_duplicate:
@userdata_destroy:
-<!-- ##### STRUCT Itdb_PhotoAlbum ##### -->
+<!-- ##### FUNCTION itdb_photodb_create ##### -->
+<para>
+
+</para>
+
+@mountpoint:
+@Returns:
+
+
+<!-- ##### FUNCTION itdb_photodb_free ##### -->
<para>
</para>
@photodb:
-@name:
-@members:
-@album_type:
-@playmusic:
-@repeat:
-@random:
-@show_titles:
-@transition_direction:
-@slide_duration:
-@transition_duration:
-@song_id:
-@unk024:
-@unk028:
-@unk044:
-@unk048:
-@album_id:
-@prev_album_id:
-@reserved_int1:
-@reserved_int2:
-@reserved1:
-@reserved2:
-@usertype:
-@userdata:
-@userdata_duplicate:
-@userdata_destroy:
+
+
+<!-- ##### FUNCTION itdb_photodb_parse ##### -->
+<para>
+
+</para>
+
+@mp:
+@error:
+@Returns:
+
+
+<!-- ##### FUNCTION itdb_photodb_write ##### -->
+<para>
+
+</para>
+
+@photodb:
+@error:
+@Returns:
+
<!-- ##### FUNCTION itdb_photodb_add_photo ##### -->
<para>
@@ -179,30 +184,56 @@ directory of the libgpod source for an example of how to use the interface.
@Returns:
-<!-- ##### FUNCTION itdb_photodb_create ##### -->
+<!-- ##### FUNCTION itdb_photodb_remove_photo ##### -->
<para>
</para>
-@mountpoint:
-@Returns:
+@db:
+@album:
+@photo:
-<!-- ##### FUNCTION itdb_photodb_free ##### -->
+<!-- ##### STRUCT Itdb_PhotoAlbum ##### -->
<para>
</para>
@photodb:
+@name:
+@members:
+@album_type:
+@playmusic:
+@repeat:
+@random:
+@show_titles:
+@transition_direction:
+@slide_duration:
+@transition_duration:
+@song_id:
+@unk024:
+@unk028:
+@unk044:
+@unk048:
+@album_id:
+@prev_album_id:
+@reserved_int1:
+@reserved_int2:
+@reserved1:
+@reserved2:
+@usertype:
+@userdata:
+@userdata_duplicate:
+@userdata_destroy:
-
-<!-- ##### FUNCTION itdb_photodb_parse ##### -->
+<!-- ##### FUNCTION itdb_photodb_photoalbum_create ##### -->
<para>
</para>
-@mp:
-@error:
+@db:
+@albumname:
+@pos:
@Returns:
@@ -227,17 +258,6 @@ directory of the libgpod source for an example of how to use the interface.
@Returns:
-<!-- ##### FUNCTION itdb_photodb_photoalbum_create ##### -->
-<para>
-
-</para>
-
-@db:
-@albumname:
-@pos:
-@Returns:
-
-
<!-- ##### FUNCTION itdb_photodb_photoalbum_remove ##### -->
<para>
@@ -248,23 +268,3 @@ directory of the libgpod source for an example of how to use the interface.
@remove_pics:
-<!-- ##### FUNCTION itdb_photodb_remove_photo ##### -->
-<para>
-
-</para>
-
-@db:
-@album:
-@photo:
-
-
-<!-- ##### FUNCTION itdb_photodb_write ##### -->
-<para>
-
-</para>
-
-@photodb:
-@error:
-@Returns:
-
-