Update of /cvsroot/gtkpod/libgpod/docs/reference
In directory sc8-pr-cvs2.sourceforge.net:/tmp/cvs-serv22787/docs/reference
Modified Files:
libgpod-docs.xml libgpod-sections.txt
Log Message:
Add PhotoDB functions to the docs.
Incorporate usage overviews from README into the docs.
Fix a few doc comments to allow gtk-doc to parse them.
Index: libgpod-docs.xml
===================================================================
RCS file: /cvsroot/gtkpod/libgpod/docs/reference/libgpod-docs.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -d -r1.2 -r1.3
--- libgpod-docs.xml 10 Jan 2007 13:25:08 -0000 1.2
+++ libgpod-docs.xml 11 Jan 2007 07:10:54 -0000 1.3
@@ -52,25 +52,54 @@
</legalnotice>
<abstract>
- <para>This manual documents the interfaces of the libgpod
- library and has some short notes to help get you up to speed
- with using the library.</para>
+ <para>
+ This manual documents the interfaces of the libgpod library and
+ has some short notes to help get you up to speed with using the
+ library.
+ </para>
+ <para>
+ Please see the programs in the <ulink type="http"
+
url="http://gtkpod.cvs.sourceforge.net/gtkpod/libgpod/tests/";>tests/</ulink>
+ directory of the source distribution for some usage examples. A more
+ complete example can be found in the source for <ulink type="http"
+ url="http://www.gtkpod.org";> Gtkpod</ulink>. You can also ask questions
+ on the developer's mailing list: <ulink
+ url="mailto:[EMAIL PROTECTED]">[EMAIL PROTECTED]</ulink>.
+ </para>
</abstract>
</bookinfo>
- <chapter>
+ <part id="itunesdb">
<title>iPod database</title>
+ <partintro>
+ <para>
+ The iPod database functions are used for adding audio and video
+ to the iPod.
+ </para>
+ </partintro>
+
<xi:include href="xml/itunesdb-db.xml"/>
<xi:include href="xml/itunesdb-copying.xml"/>
<xi:include href="xml/itunesdb-time.xml"/>
<xi:include href="xml/itunesdb-lowlevel.xml"/>
- </chapter>
- <chapter>
- <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>
+ <chapter>
+ <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>
+ </part>
+
+ <part id="photodb">
+ <title>Photo database</title>
+ <partintro>
+ <para>
+ The Photo database functions are used for adding pictures to
+ the iPod.
+ </para>
+ </partintro>
+ <xi:include href="xml/photodb.xml"/>
+ </part>
</book>
Index: libgpod-sections.txt
===================================================================
RCS file: /cvsroot/gtkpod/libgpod/docs/reference/libgpod-sections.txt,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -d -r1.2 -r1.3
--- libgpod-sections.txt 10 Jan 2007 13:25:09 -0000 1.2
+++ libgpod-sections.txt 11 Jan 2007 07:10:54 -0000 1.3
@@ -185,6 +185,24 @@
itdb_thumb_get_filename
</SECTION>
+<SECTION>
+<FILE>photodb</FILE>
+<TITLE>Photo database</TITLE>
+Itdb_PhotoAlbum
+Itdb_PhotoDB
+itdb_photodb_add_photo
+itdb_photodb_add_photo_from_data
+itdb_photodb_create
+itdb_photodb_free
+itdb_photodb_parse
+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>
+
-------------------------------------------------------------------------
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
