diff options
| author | Todd Zullinger <tmzullinger@users.sourceforge.net> | 2007-01-11 07:10:55 +0000 |
|---|---|---|
| committer | Todd Zullinger <tmzullinger@users.sourceforge.net> | 2007-01-11 07:10:55 +0000 |
| commit | 517d4c9dca936c1a0ccb93271a3fa492df9951fc (patch) | |
| tree | d06c5b7bb275916821dacf79cf68b51afab4de05 /docs/reference/libgpod-docs.xml | |
| parent | 22851021f35d76c849b55da808da2b3e44eef3c7 (diff) | |
| download | libgpod-517d4c9dca936c1a0ccb93271a3fa492df9951fc.tar.gz libgpod-517d4c9dca936c1a0ccb93271a3fa492df9951fc.tar.xz libgpod-517d4c9dca936c1a0ccb93271a3fa492df9951fc.zip | |
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.
git-svn-id: https://gtkpod.svn.sf.net/svnroot/gtkpod/libgpod/trunk@1356 f01d2545-417e-4e96-918e-98f8d0dbbcb6
Diffstat (limited to 'docs/reference/libgpod-docs.xml')
| -rw-r--r-- | docs/reference/libgpod-docs.xml | 55 |
1 files changed, 42 insertions, 13 deletions
diff --git a/docs/reference/libgpod-docs.xml b/docs/reference/libgpod-docs.xml index bb66747..d80fd43 100644 --- a/docs/reference/libgpod-docs.xml +++ b/docs/reference/libgpod-docs.xml @@ -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:gtkpod-devel@lists.sourceforge.net">gtkpod-devel@lists.sourceforge.net</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> |