diff options
| author | Todd Zullinger <tmz@pobox.com> | 2008-07-17 20:27:45 -0400 |
|---|---|---|
| committer | Todd Zullinger <tmz@pobox.com> | 2008-11-14 12:12:57 -0500 |
| commit | fd597deca5205389cbfa4eb0f290c4fda72f0812 (patch) | |
| tree | 37b4034edae72ee521f0411fecd07ec6253dc4ba /docs/reference | |
| parent | 952af46f2c179bb3de51f0f4b903b3c57e4442ee (diff) | |
| download | libgpod-fd597deca5205389cbfa4eb0f290c4fda72f0812.tar.gz libgpod-fd597deca5205389cbfa4eb0f290c4fda72f0812.tar.xz libgpod-fd597deca5205389cbfa4eb0f290c4fda72f0812.zip | |
Documentation: add a number of enums, macros, and structs
Diffstat (limited to 'docs/reference')
| -rw-r--r-- | docs/reference/libgpod-sections.txt | 4 | ||||
| -rw-r--r-- | docs/reference/tmpl/chapterdata.sgml | 5 | ||||
| -rw-r--r-- | docs/reference/tmpl/itunesdb-db.sgml | 11 | ||||
| -rw-r--r-- | docs/reference/tmpl/libgpod-unused.sgml | 22 | ||||
| -rw-r--r-- | docs/reference/tmpl/photodb.sgml | 35 |
5 files changed, 34 insertions, 43 deletions
diff --git a/docs/reference/libgpod-sections.txt b/docs/reference/libgpod-sections.txt index a930fe7..4c4cd81 100644 --- a/docs/reference/libgpod-sections.txt +++ b/docs/reference/libgpod-sections.txt @@ -2,6 +2,7 @@ <FILE>itunesdb-db</FILE> <TITLE>The Itdb_iTunesDB structure</TITLE> Itdb_iTunesDB +ItdbFileError ItdbUserDataDestroyFunc ItdbUserDataDuplicateFunc @@ -214,8 +215,8 @@ itdb_thumb_to_pixbufs <SECTION> <FILE>photodb</FILE> <TITLE>Photo database</TITLE> -Itdb_PhotoAlbum Itdb_PhotoDB +Itdb_PhotoAlbum itdb_photodb_add_photo itdb_photodb_add_photo_from_data itdb_photodb_add_photo_from_pixbuf @@ -280,7 +281,6 @@ db_parse_context_get_m_header iPodSong DB_TO_CPU_GET DB_TO_CPU_GET_DB -ItdbFileError ITDB_FILE_ERROR itdb_file_error_quark ITDB_DEVICE_ERROR diff --git a/docs/reference/tmpl/chapterdata.sgml b/docs/reference/tmpl/chapterdata.sgml index f76f63b..6c83b9b 100644 --- a/docs/reference/tmpl/chapterdata.sgml +++ b/docs/reference/tmpl/chapterdata.sgml @@ -2,11 +2,12 @@ Chapter Data <!-- ##### SECTION Short_Description ##### --> - +Data structure to store chapter data for tracks <!-- ##### SECTION Long_Description ##### --> <para> - +Chapters allow for a large file to be divided into sections. The start and stop +points in the track are defined here, as well as the title for each chapter. </para> <!-- ##### SECTION See_Also ##### --> diff --git a/docs/reference/tmpl/itunesdb-db.sgml b/docs/reference/tmpl/itunesdb-db.sgml index 27d3f52..0d1be9c 100644 --- a/docs/reference/tmpl/itunesdb-db.sgml +++ b/docs/reference/tmpl/itunesdb-db.sgml @@ -116,6 +116,17 @@ to the library _duplicate()/_free() functions. @userdata_duplicate: @userdata_destroy: +<!-- ##### ENUM ItdbFileError ##### --> +<para> + +</para> + +@ITDB_FILE_ERROR_SEEK: +@ITDB_FILE_ERROR_CORRUPT: +@ITDB_FILE_ERROR_NOTFOUND: +@ITDB_FILE_ERROR_RENAME: +@ITDB_FILE_ERROR_ITDB_CORRUPT: + <!-- ##### USER_FUNCTION ItdbUserDataDestroyFunc ##### --> <para> diff --git a/docs/reference/tmpl/libgpod-unused.sgml b/docs/reference/tmpl/libgpod-unused.sgml index 8df8383..2fae13d 100644 --- a/docs/reference/tmpl/libgpod-unused.sgml +++ b/docs/reference/tmpl/libgpod-unused.sgml @@ -118,28 +118,6 @@ iTunesDB </para> -<!-- ##### ENUM ItdbFileError ##### --> -<para> - -</para> - -@ITDB_FILE_ERROR_SEEK: -@ITDB_FILE_ERROR_CORRUPT: -@ITDB_FILE_ERROR_NOTFOUND: -@ITDB_FILE_ERROR_RENAME: -@ITDB_FILE_ERROR_ITDB_CORRUPT: - -<!-- ##### ENUM ItdbThumbDataType ##### --> -<para> - -</para> - -@ITDB_THUMB_TYPE_INVALID: -@ITDB_THUMB_TYPE_FILE: -@ITDB_THUMB_TYPE_MEMORY: -@ITDB_THUMB_TYPE_PIXBUF: -@ITDB_THUMB_TYPE_IPOD: - <!-- ##### ENUM Itdb_Generation ##### --> <para> diff --git a/docs/reference/tmpl/photodb.sgml b/docs/reference/tmpl/photodb.sgml index 59a7a4d..1d53086 100644 --- a/docs/reference/tmpl/photodb.sgml +++ b/docs/reference/tmpl/photodb.sgml @@ -90,11 +90,29 @@ directory of the libgpod source for an example of how to use the interface. <!-- ##### SECTION Stability_Level ##### --> +<!-- ##### STRUCT Itdb_PhotoDB ##### --> +<para> + +</para> + +@photos: +@photoalbums: +@device: +@reserved_int1: +@reserved_int2: +@reserved1: +@reserved2: +@usertype: +@userdata: +@userdata_duplicate: +@userdata_destroy: + <!-- ##### STRUCT Itdb_PhotoAlbum ##### --> <para> </para> +@photodb: @name: @members: @album_type: @@ -121,23 +139,6 @@ directory of the libgpod source for an example of how to use the interface. @userdata_duplicate: @userdata_destroy: -<!-- ##### STRUCT Itdb_PhotoDB ##### --> -<para> - -</para> - -@photos: -@photoalbums: -@device: -@reserved_int1: -@reserved_int2: -@reserved1: -@reserved2: -@usertype: -@userdata: -@userdata_duplicate: -@userdata_destroy: - <!-- ##### FUNCTION itdb_photodb_add_photo ##### --> <para> |
