summaryrefslogtreecommitdiffstats
path: root/docs/reference/tmpl/device.sgml
diff options
context:
space:
mode:
authorChristophe Fergeau <teuf@gnome.org>2006-04-10 18:17:25 +0000
committerChristophe Fergeau <teuf@gnome.org>2006-04-10 18:17:25 +0000
commit94ca87f3e5f9a2de994893f4927bd374f36a8dc7 (patch)
tree5129c69fdbd110e8c536ce0fc4082b4b1a90dbe1 /docs/reference/tmpl/device.sgml
parent7252444ca4b911507beaa9d62f6ddb28520b2284 (diff)
downloadlibgpod-94ca87f3e5f9a2de994893f4927bd374f36a8dc7.tar.gz
libgpod-94ca87f3e5f9a2de994893f4927bd374f36a8dc7.tar.xz
libgpod-94ca87f3e5f9a2de994893f4927bd374f36a8dc7.zip
* docs/Makefile.am:
* docs/reference/Makefile.am: * docs/reference/libgpod-docs.xml: * docs/reference/libgpod-sections.txt: * docs/reference/tmpl/Internal.sgml: * docs/reference/tmpl/artwork.sgml: * docs/reference/tmpl/device.sgml: * docs/reference/tmpl/itunesdb-copying.sgml: * docs/reference/tmpl/itunesdb-db.sgml: * docs/reference/tmpl/itunesdb-lowlevel.sgml: * docs/reference/tmpl/itunesdb-time.sgml: * docs/reference/tmpl/libgpod-unused.sgml: * docs/reference/tmpl/playlists.sgml: * docs/reference/tmpl/smart-playlists.sgml: * docs/reference/tmpl/track.sgml: * docs/reference/version.xml.in: all the files below are new files needed for gtk-doc support * Makefile.am: * configure.ac: add gtk-doc support to build system * src/itdb_artwork.c: * src/itdb_device.c: * src/itdb_itunesdb.c: * src/itdb_playlist.c: * src/itdb_track.c: update inline comments in those files so that gtk-doc can pick them up to build documentation git-svn-id: https://gtkpod.svn.sf.net/svnroot/gtkpod/libgpod/trunk@1243 f01d2545-417e-4e96-918e-98f8d0dbbcb6
Diffstat (limited to 'docs/reference/tmpl/device.sgml')
-rw-r--r--docs/reference/tmpl/device.sgml129
1 files changed, 129 insertions, 0 deletions
diff --git a/docs/reference/tmpl/device.sgml b/docs/reference/tmpl/device.sgml
new file mode 100644
index 0000000..07090ed
--- /dev/null
+++ b/docs/reference/tmpl/device.sgml
@@ -0,0 +1,129 @@
+<!-- ##### SECTION Title ##### -->
+Device
+
+<!-- ##### SECTION Short_Description ##### -->
+Data structure holding information about the iPod (model, mount point, ...)
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### STRUCT Itdb_Device ##### -->
+<para>
+
+</para>
+
+@mountpoint:
+@musicdirs:
+@byte_order:
+@endianess_reversed:
+
+<!-- ##### FUNCTION itdb_device_new ##### -->
+<para>
+
+</para>
+
+@Returns:
+
+
+<!-- ##### FUNCTION itdb_device_free ##### -->
+<para>
+
+</para>
+
+@device:
+
+
+<!-- ##### FUNCTION itdb_device_set_mountpoint ##### -->
+<para>
+
+</para>
+
+@device:
+@mp:
+
+
+<!-- ##### FUNCTION itdb_device_read_sysinfo ##### -->
+<para>
+
+</para>
+
+@device:
+@Returns:
+
+
+<!-- ##### FUNCTION itdb_device_get_sysinfo ##### -->
+<para>
+
+</para>
+
+@device:
+@field:
+@Returns:
+
+
+<!-- ##### STRUCT Itdb_IpodModel ##### -->
+<para>
+
+</para>
+
+@model_number:
+@capacity:
+@model_type:
+@generation:
+
+<!-- ##### STRUCT Itdb_ArtworkFormat ##### -->
+<para>
+
+</para>
+
+@type:
+@width:
+@height:
+@correlation_id:
+
+<!-- ##### ENUM Itdb_Generation ##### -->
+<para>
+
+</para>
+
+@UNKNOWN_GENERATION:
+@FIRST_GENERATION:
+@SECOND_GENERATION:
+@THIRD_GENERATION:
+@FOURTH_GENERATION:
+@FIFTH_GENERATION:
+@MOBILE_GENERATION:
+
+<!-- ##### ENUM Itdb_ModelType ##### -->
+<para>
+
+</para>
+
+@MODEL_TYPE_INVALID:
+@MODEL_TYPE_UNKNOWN:
+@MODEL_TYPE_COLOR:
+@MODEL_TYPE_COLOR_U2:
+@MODEL_TYPE_REGULAR:
+@MODEL_TYPE_REGULAR_U2:
+@MODEL_TYPE_MINI:
+@MODEL_TYPE_MINI_BLUE:
+@MODEL_TYPE_MINI_PINK:
+@MODEL_TYPE_MINI_GREEN:
+@MODEL_TYPE_MINI_GOLD:
+@MODEL_TYPE_SHUFFLE:
+@MODEL_TYPE_NANO_WHITE:
+@MODEL_TYPE_NANO_BLACK:
+@MODEL_TYPE_VIDEO_WHITE:
+@MODEL_TYPE_VIDEO_BLACK:
+@MODEL_TYPE_MOBILE_1:
+