[gtpd-cvs] libgpod/docs/reference Makefile.am,NONE,1.1 libgpod-docs.xml,NONE,1.1 libgpod-sections.txt,NONE,1.1 version.xml.in,NONE,1.1

Update of /cvsroot/gtkpod/libgpod/docs/reference
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv20335/docs/reference

Added Files:
        Makefile.am libgpod-docs.xml libgpod-sections.txt 
        version.xml.in 
Log Message:
* 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


--- NEW FILE: Makefile.am ---
## Process this file with automake to produce Makefile.in

# We require automake 1.6 at least.
AUTOMAKE_OPTIONS = 1.6

# This is a blank Makefile.am for using gtk-doc.
# Copy this to your project's API docs directory and modify the variables to
# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
# of using the various options.

# The name of the module, e.g. 'glib'.
DOC_MODULE=libgpod

# The top-level SGML file. You can change this if you want to.
DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml

# The directory containing the source code. Relative to $(srcdir).
# gtk-doc will search all .c & .h files beneath here for inline comments
# documenting the functions and macros.
# e.g. DOC_SOURCE_DIR=../../../gtk
DOC_SOURCE_DIR=../../src

# Extra options to pass to gtkdoc-scangobj. Not normally needed.
SCANGOBJ_OPTIONS=

# Extra options to supply to gtkdoc-scan.
# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED" 
SCAN_OPTIONS=

# Extra options to supply to gtkdoc-mkdb.
# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
MKDB_OPTIONS=--sgml-mode --output-format=xml

# Extra options to supply to gtkdoc-mktmpl
# e.g. MKTMPL_OPTIONS=--only-section-tmpl
MKTMPL_OPTIONS=

# Extra options to supply to gtkdoc-fixref. Not normally needed.
# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
FIXXREF_OPTIONS=

# Used for dependencies. The docs will be rebuilt if any of these change.
# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
HFILE_GLOB=$(top_srcdir)/src/*.h
CFILE_GLOB=$(top_srcdir)/src/*.c

# Header files to ignore when scanning.
# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
IGNORE_HFILES=

# Images to copy into HTML directory.
# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
HTML_IMAGES=

# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
content_files=

# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
# These files must be listed here *and* in content_files
# e.g. expand_content_files=running.sgml
expand_content_files=

# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
# Only needed if you are using gtkdoc-scangobj to dynamically query widget
# signals and properties.
# e.g. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
INCLUDES=
GTKDOC_LIBS=

# This includes the standard gtk-doc make rules, copied by gtkdocize.
include $(top_srcdir)/gtk-doc.make

# Other files to distribute
# e.g. EXTRA_DIST += version.xml.in
EXTRA_DIST += 

--- NEW FILE: libgpod-docs.xml ---
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd";>
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude";>
  <bookinfo>
    <title>libgpod Reference Manual</title>
    <releaseinfo>for libgpod <xi:include href="version.xml"/></releaseinfo>
    <authorgroup>
      <author>
        <firstname>Jorg</firstname>
        <surname>Schuler</surname>
        <affiliation>
          <address>
            <email>jorg.schuler@xxxxxx</email>
          </address>
        </affiliation>
      </author>
      <author>
        <firstname>Christophe</firstname>
        <surname>Fergeau</surname>
        <affiliation>
          <address>
            <email>teuf@xxxxxxxxx</email>
          </address>
        </affiliation>
      </author>
    </authorgroup>
    <copyright>
      <year>2006</year>
      <holder>Christophe Fergeau</holder>
    </copyright>

    <legalnotice>
      <para>Permission is granted to copy, distribute and/or modify
      this document under the terms of the <citetitle>GNU Free
      Documentation License</citetitle>, Version 1.1 or any later
      version published by the Free Software Foundation with no
      Invariant Sections, no Front-Cover Texts, and no Back-Cover
      Texts. You may obtain a copy of the <citetitle>GNU Free
      Documentation License</citetitle> from the Free Software
      Foundation by visiting <ulink type="http"
      url="http://www.fsf.org";>their Web site</ulink> or by writing
      to: Free Software Foundation, Inc., 59 Temple Place - Suite 330,
      Boston, MA 02111-1307, USA.</para>

      <para>Many of the names used by companies to distinguish their
      products and services are claimed as trademarks. Where those
      names appear in any GNOME documentation, and those trademarks
      are made aware to the members of the GNOME Documentation
      Project, the names have been printed in caps or initial
      caps.</para>
    </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>
    </abstract>
  </bookinfo>

  <chapter>
    <title>iPod database</title>
    <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/artwork.xml"/>
    <xi:include href="xml/device.xml"/>
  </chapter>
</book>

--- NEW FILE: libgpod-sections.txt ---
<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>


--- NEW FILE: version.xml.in ---
<?xml version="1.0" standalone="no"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd";>
<phrase>@LIBGPOD_VERSION@</phrase>



-------------------------------------------------------
This SF.Net email is sponsored by xPML, a groundbreaking scripting language
that extends applications into web and mobile media. Attend the live webcast
and join the prime developer group breaking into this new coding territory!
http://sel.as-us.falkag.net/sel?cmd=lnk&kid=110944&bid=241720&dat=121642