* 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

1 files changed, 266 insertions, 0 deletions

diff --git a/docs/reference/libgpod-sections.txt b/docs/reference/libgpod-sections.txt
new file mode 100644
index 0000000..676f4d6
--- /dev/null
+++ b/docs/reference/libgpod-sections.txt
@@ -0,0 +1,266 @@
+<SECTION>
+<FILE>itunesdb-db</FILE>
+<TITLE>The Itdb_iTunesDB structure</TITLE>
+Itdb_iTunesDB
+ItdbUserDataDestroyFunc
+ItdbUserDataDuplicateFunc
+
+itdb_new
+itdb_free
+itdb_parse
+itdb_write
+itdb_set_mountpoint
+itdb_get_mountpoint
+
+itdb_tracks_number
+itdb_tracks_number_nontransferred
+itdb_playlists_number
+</SECTION>
+
+<SECTION>
+<FILE>itunesdb-copying</FILE>
+<TITLE>File handling functions</TITLE>
+itdb_cp_track_to_ipod
+itdb_filename_fs2ipod
+itdb_filename_ipod2fs
+itdb_filename_on_ipod
+itdb_musicdirs_number
+itdb_rename_files
+</SECTION>
+
+<SECTION>
+<FILE>itunesdb-lowlevel</FILE>
+<TITLE>Low-level functions</TITLE>
+itdb_get_control_dir
+itdb_get_itunes_dir
+itdb_get_music_dir
+itdb_get_artwork_dir
+itdb_get_device_dir
+itdb_get_itunesdb_path
+itdb_get_artworkdb_path
+itdb_get_path
+
+itdb_resolve_path
+itdb_shuffle_write
+itdb_shuffle_write_file
+itdb_cp
+itdb_parse_file
+itdb_write_file
+itdb_duplicate
+</SECTION>
+
+<SECTION>
+<FILE>itunesdb-time</FILE>
+<TITLE>Time handling</TITLE>
+itdb_time_get_mac_time
+itdb_time_mac_to_host
+itdb_time_host_to_mac
+</SECTION>
+
+<SECTION>
+<FILE>track</FILE>
+<TITLE>Tracks</TITLE>
+Itdb_Track
+itdb_track_new
+itdb_track_free
+itdb_track_add
+itdb_track_remove
+itdb_track_unlink
+itdb_track_duplicate
+itdb_track_by_id
+itdb_track_id_tree_create
+itdb_track_id_tree_destroy
+itdb_track_id_tree_by_id
+itdb_track_set_thumbnails
+itdb_track_remove_thumbnails
+ITDB_RATING_STEP
+</SECTION>
+
+
+<SECTION>
+<FILE>playlists</FILE>
+<TITLE>Playlists</TITLE>
+Itdb_Playlist
+ItdbPlaylistSortOrder
+itdb_playlist_new
+itdb_playlist_free
+itdb_playlist_duplicate
+itdb_playlist_add
+itdb_playlist_move
+itdb_playlist_remove
+itdb_playlist_unlink
+
+itdb_playlist_add_track
+itdb_playlist_remove_track
+itdb_playlist_contains_track
+itdb_playlist_contain_track_number
+itdb_playlist_tracks_number
+
+itdb_playlist_mpl
+itdb_playlist_is_mpl
+itdb_playlist_set_mpl
+itdb_playlist_podcasts
+itdb_playlist_is_podcasts
+itdb_playlist_set_podcasts
+itdb_playlist_exists
+itdb_playlist_by_id
+itdb_playlist_by_nr
+itdb_playlist_by_name
+
+itdb_playlist_randomize
+</SECTION>
+
+<SECTION>
+<FILE>smart-playlists</FILE>
+<TITLE>Smart Playlists</TITLE>
+SPLPref
+SPLRule
+SPLRules
+SPLAction
+SPLFieldType
+SPLActionType
+SPLField
+SPLDATE_IDENTIFIER
+SPL_MAXSTRINGLENGTH
+SPL_STRING_MAXLEN
+itdb_splr_get_field_type
+itdb_splr_get_action_type
+itdb_splr_validate
+itdb_splr_remove
+itdb_splr_new
+itdb_splr_add
+itdb_splr_add_new
+itdb_spl_copy_rules
+itdb_splr_eval
+itdb_spl_update
+itdb_spl_update_all
+itdb_spl_update_live
+</SECTION>
+
+<SECTION>
+<FILE>device</FILE>
+<TITLE>Device</TITLE>
+Itdb_Device
+itdb_device_new
+itdb_device_free
+itdb_device_set_mountpoint
+itdb_device_read_sysinfo
+itdb_device_get_sysinfo
+Itdb_IpodModel
+Itdb_ArtworkFormat
+Itdb_Generation
+Itdb_ModelType
+</SECTION>
+
+<SECTION>
+<FILE>artwork</FILE>
+<TITLE>Artwork</TITLE>
+Itdb_Artwork
+Itdb_Thumb
+ItdbThumbType
+itdb_artwork_new
+itdb_artwork_duplicate
+itdb_artwork_free
+itdb_artwork_add_thumbnail
+itdb_artwork_remove_thumbnail
+itdb_artwork_remove_thumbnails
+itdb_artwork_get_thumb_by_type
+itdb_thumb_get_gdk_pixbuf
+itdb_thumb_duplicate
+itdb_thumb_free
+itdb_thumb_new
+itdb_thumb_get_filename
+</SECTION>
+
+
+
+
+<SECTION>
+<FILE>Internal</FILE>
+<SUBSECTION Private>
+G_GNUC_INTERNAL
+g_stat
+g_mkdir
+g_rename
+g_printf
+G_IS_DIR_SEPARATOR
+dump_mhif
+dump_mhia
+dump_mhod_type_1
+dump_mhod_type_3
+dump_mhni
+dump_mhod
+dump_mhii
+dump_mhl
+dump_mhsd
+dump_mhfd
+dump_mhba
+ITUNESDB_MAX_SIZE
+MHeader
+MhlHeader
+MhbdHeader
+ArtworkDB_MhsdHeader
+MhltHeader
+MhlpHeader
+MhypHeader
+MhipHeader
+MhitHeader
+ArtworkDB_MhodHeader
+MhfdHeader
+MhliHeader
+MhiiHeader
+MhniHeader
+MhlaHeader
+MhbaHeader
+MhlfHeader
+MhifHeader
+MhiaHeader
+MhitHeader471
+ArtworkDB_MhodHeaderArtworkType3
+MhodHeaderString
+MhodHeaderArtworkType1
+MhodHeaderSmartPlaylistData
+MhodHeaderSmartPlaylistRuleString
+MhodHeaderSmartPlaylistRuleNonString
+MhodHeaderSmartPlaylistRule
+iTunesDB_MhsdHeader
+MhodHeader
+_MhodHeaderArtworkType1
+MhodHeaderArtworkType3
+playcount
+NO_PLAYCOUNT
+WCONTENTS_STEPSIZE
+RED_BITS
+RED_SHIFT
+RED_MASK
+GREEN_BITS
+GREEN_SHIFT
+GREEN_MASK
+BLUE_BITS
+BLUE_SHIFT
+BLUE_MASK
+DBParseContext
+db_parse_context_get_m_header
+iPodSong
+DB_TO_CPU_GET
+DB_TO_CPU_GET_DB
+ItdbFileError
+ITDB_FILE_ERROR
+itdb_file_error_quark
+
+SPLACTION_LAST_HOURS_VALUE
+SPLACTION_LAST_MINUTES_VALUE
+SPLACTION_LAST_YEARS_VALUE
+SPLACTION_LAST_LUNARCYCLE_VALUE
+SPLACTION_LAST_SIDEREAL_DAY
+SPLACTION_LAST_SWATCH_BEAT
+SPLACTION_LAST_MOMENT
+SPLACTION_LAST_OSTENT
+SPLACTION_LAST_FORTNIGHT
+SPLACTION_LAST_VINAL
+SPLACTION_LAST_QUARTER
+SPLACTION_LAST_SOLAR_YEAR
+SPLACTION_LAST_SIDEREAL_YEAR
+
+</SECTION>
+