GNOME.org
 

totem-pl-parser r292 - in trunk: . docs/reference plparse

Author: pwithnall
Date: Sat Feb  7 19:13:34 2009
New Revision: 292
URL: http://svn.gnome.org/viewvc/totem-pl-parser?rev=292&view=rev

Log:
2009-02-07  Philip Withnall  <philip tecnocode co uk>

	* configure.in:
	* docs/reference/Makefile.am:
	* docs/reference/totem-pl-parser-docs.sgml:
	* docs/reference/totem-pl-parser-docs.xml:
	* docs/reference/totem-pl-parser-sections.txt:
	* plparse/totem-disc.c:
	* plparse/totem-pl-parser.c:
	* plparse/totem-pl-parser.h: Tidy up the documentation a bit, taking
	advantage of recent gtk-doc features, and also adding missing "since"
	and "deprecated" tags to a few symbols. gtkdoc-check will now run on
	`make check`.



Added:
   trunk/docs/reference/totem-pl-parser-docs.xml   (contents, props changed)
      - copied, changed from r291, /trunk/docs/reference/totem-pl-parser-docs.sgml
Removed:
   trunk/docs/reference/totem-pl-parser-docs.sgml
Modified:
   trunk/ChangeLog
   trunk/configure.in
   trunk/docs/reference/Makefile.am
   trunk/docs/reference/totem-pl-parser-sections.txt
   trunk/plparse/totem-disc.c
   trunk/plparse/totem-pl-parser.c
   trunk/plparse/totem-pl-parser.h

Modified: trunk/configure.in
==============================================================================
--- trunk/configure.in	(original)
+++ trunk/configure.in	Sat Feb  7 19:13:34 2009
@@ -120,7 +120,7 @@
 AC_SUBST([AM_CXXFLAGS])
 AC_SUBST([AM_LDFLAGS])
 
-GTK_DOC_CHECK(1.0)
+GTK_DOC_CHECK(1.11)
 
 AC_CONFIG_FILES([
 Makefile

Modified: trunk/docs/reference/Makefile.am
==============================================================================
--- trunk/docs/reference/Makefile.am	(original)
+++ trunk/docs/reference/Makefile.am	Sat Feb  7 19:13:34 2009
@@ -12,7 +12,7 @@
 DOC_MODULE=totem-pl-parser
 
 # The top-level SGML file. You can change this if you want to.
-DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
+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
@@ -29,7 +29,7 @@
 
 # Extra options to supply to gtkdoc-mkdb.
 # e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
-MKDB_OPTIONS=--sgml-mode --output-format=xml
+MKDB_OPTIONS=--sgml-mode --output-format=xml --name-space=totem_pl_parser
 
 # Extra options to supply to gtkdoc-mktmpl
 # e.g. MKTMPL_OPTIONS=--only-section-tmpl
@@ -95,3 +95,5 @@
 # Other files to distribute
 # e.g. EXTRA_DIST += version.xml.in
 EXTRA_DIST += version.xml.in
+
+TESTS = $(GTKDOC_CHECK)

Copied: trunk/docs/reference/totem-pl-parser-docs.xml (from r291, /trunk/docs/reference/totem-pl-parser-docs.sgml)
==============================================================================
--- /trunk/docs/reference/totem-pl-parser-docs.sgml	(original)
+++ trunk/docs/reference/totem-pl-parser-docs.xml	Sat Feb  7 19:13:34 2009
@@ -1,20 +1,30 @@
 <?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"; [
-<!ENTITY version SYSTEM "version.xml">
-<!ENTITY slash "/">
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"; [
+	<!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
+	<!ENTITY version SYSTEM "version.xml">
+	<!ENTITY slash "/">
 ]>
 <book id="index" xmlns:xi="http://www.w3.org/2003/XInclude";>
-  <bookinfo>
-    <title>Totem Playlist Parser Reference Manual</title>
-    <releaseinfo>
-      for totem-pl-parser &version;
-    </releaseinfo>
-  </bookinfo>
+	<bookinfo>
+		<title>Totem Playlist Parser Reference Manual</title>
+		<releaseinfo>
+			for totem-pl-parser &version;. The latest version of this documentation can be found online at
+			<ulink role="online-location" url="http://library.gnome.org/devel/totem-pl-parser/";>http://library.gnome.org/devel/totem-pl-parser/</ulink>.
+		</releaseinfo>
+	</bookinfo>
 
-  <chapter>
-    <title>API Reference</title>
-    <xi:include href="xml/totem-pl-parser.xml"/>
-    <xi:include href="xml/totem-disc.xml"/>
-  </chapter>
+	<chapter id="api-reference">
+		<title>API Reference</title>
+		<xi:include href="xml/totem-pl-parser.xml"/>
+		<xi:include href="xml/totem-disc.xml"/>
+	</chapter>
+
+	<index id="api-index-full">
+		<title>Index of all symbols</title>
+		<xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
+	</index>
+	<index id="api-index-deprecated" role="deprecated">
+		<title>Index of deprecated symbols</title>
+		<xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
+	</index>
 </book>

Modified: trunk/docs/reference/totem-pl-parser-sections.txt
==============================================================================
--- trunk/docs/reference/totem-pl-parser-sections.txt	(original)
+++ trunk/docs/reference/totem-pl-parser-sections.txt	Sat Feb  7 19:13:34 2009
@@ -1,5 +1,6 @@
 <SECTION>
 <FILE>totem-pl-parser</FILE>
+<TITLE>TotemPlParser</TITLE>
 TotemPlParser
 TotemPlParserClass
 TotemPlParserResult
@@ -16,6 +17,7 @@
 totem_pl_parser_add_ignored_scheme
 totem_pl_parser_add_ignored_mimetype
 TOTEM_PL_PARSER_FIELD_URI
+TOTEM_PL_PARSER_FIELD_URL
 TOTEM_PL_PARSER_FIELD_GENRE
 TOTEM_PL_PARSER_FIELD_TITLE
 TOTEM_PL_PARSER_FIELD_AUTHOR
@@ -39,7 +41,9 @@
 TOTEM_PL_PARSER_FIELD_LANGUAGE
 TOTEM_PL_PARSER_FIELD_CONTACT
 TOTEM_PL_PARSER_FIELD_IMAGE_URI
+TOTEM_PL_PARSER_FIELD_IMAGE_URL
 TOTEM_PL_PARSER_FIELD_DOWNLOAD_URI
+TOTEM_PL_PARSER_FIELD_DOWNLOAD_URL
 TOTEM_PL_PARSER_FIELD_ID
 TOTEM_PL_PARSER_FIELD_IS_PLAYLIST
 <SUBSECTION Standard>
@@ -51,6 +55,8 @@
 TOTEM_IS_PL_PARSER_CLASS
 totem_pl_parser_error_quark
 TOTEM_PL_PARSER_ERROR
+TOTEM_TYPE_PL_PARSER_METADATA
+totem_pl_parser_metadata_get_type
 <SUBSECTION Private>
 TotemPlParserPrivate
 entry_parsed

Modified: trunk/plparse/totem-disc.c
==============================================================================
--- trunk/plparse/totem-disc.c	(original)
+++ trunk/plparse/totem-disc.c	Sat Feb  7 19:13:34 2009
@@ -38,7 +38,7 @@
  *
  * The functions in this file refer to MRLs, which are a special form
  * of URIs used by xine to refer to things such as DVDs. An example of
- * an MRL would be <example>dvd:///dev/scd0</example>, which is not a
+ * an MRL would be <literal>dvd:///dev/scd0</literal>, which is not a
  * valid URI as far as, for example, GIO is concerned.
  *
  * The rest of the totem-pl-parser API exclusively uses URIs.

Modified: trunk/plparse/totem-pl-parser.c
==============================================================================
--- trunk/plparse/totem-pl-parser.c	(original)
+++ trunk/plparse/totem-pl-parser.c	Sat Feb  7 19:13:34 2009
@@ -63,7 +63,9 @@
  *  <title>Writing a Playlist</title>
  *  <programlisting>
  * void
- * parser_func (GtkTreeModel *model, GtkTreeIter *iter, gchar **uri, gchar **title, gboolean *custom_title, gpointer user_data)
+ * parser_func (GtkTreeModel *model, GtkTreeIter *iter,
+ * 		gchar **uri, gchar **title, gboolean *custom_title,
+ * 		gpointer user_data)
  * {
  * 	gtk_tree_model_get (model, iter,
  * 		0, uri,
@@ -83,8 +85,10 @@
  * 	tree_model = gtk_list_store_new (3, G_TYPE_STRING, G_TYPE_STRING, G_TYPE_BOOLEAN);
  * 	populate_model (tree_model);
  *
- * 	if (totem_pl_parser_write (pl, tree_model, parser_func, "/tmp/playlist.pls", TOTEM_PL_PARSER_PLS, NULL, NULL) != TRUE)
+ * 	if (totem_pl_parser_write (pl, tree_model, parser_func, "/tmp/playlist.pls",
+ * 				   TOTEM_PL_PARSER_PLS, NULL, NULL) != TRUE) {
  * 		g_error ("Playlist writing failed.");
+ * 	}
  *
  * 	g_object_unref (tree_model);
  * 	g_object_unref (pl);

Modified: trunk/plparse/totem-pl-parser.h
==============================================================================
--- trunk/plparse/totem-pl-parser.h	(original)
+++ trunk/plparse/totem-pl-parser.h	Sat Feb  7 19:13:34 2009
@@ -32,8 +32,31 @@
 G_BEGIN_DECLS
 
 /* Compatibility defines */
+
+/**
+ * TOTEM_PL_PARSER_FIELD_URL:
+ *
+ * Metadata field for an entry's URL.
+ *
+ * Deprecated: 2.26: Use %TOTEM_PL_PARSER_FIELD_URI instead.
+ **/
 #define TOTEM_PL_PARSER_FIELD_URL		TOTEM_PL_PARSER_FIELD_URI
+/**
+ * TOTEM_PL_PARSER_FIELD_IMAGE_URL:
+ *
+ * Metadata field for an entry's thumbnail image URL.
+ *
+ * Deprecated: 2.26: Use %TOTEM_PL_PARSER_FIELD_IMAGE_URI instead.
+ **/
 #define TOTEM_PL_PARSER_FIELD_IMAGE_URL		TOTEM_PL_PARSER_FIELD_IMAGE_URI
+/**
+ * TOTEM_PL_PARSER_FIELD_DOWNLOAD_URL:
+ *
+ * Metadata field for an entry's download URL. Only used if an alternate download
+ * location is available for the entry.
+ *
+ * Deprecated: 2.26: Use %TOTEM_PL_PARSER_FIELD_DOWNLOAD_URI instead.
+ **/
 #define TOTEM_PL_PARSER_FIELD_DOWNLOAD_URL	TOTEM_PL_PARSER_FIELD_DOWNLOAD_URI
 /* End */
 
@@ -52,8 +75,7 @@
  *
  * Gives the result of parsing a playlist.
  **/
-typedef enum
-{
+typedef enum {
 	TOTEM_PL_PARSER_RESULT_UNHANDLED,
 	TOTEM_PL_PARSER_RESULT_ERROR,
 	TOTEM_PL_PARSER_RESULT_SUCCESS,
@@ -80,6 +102,8 @@
  * TOTEM_PL_PARSER_FIELD_URI:
  *
  * Metadata field for an entry's URI.
+ *
+ * Since: 2.26
  **/
 #define TOTEM_PL_PARSER_FIELD_URI		"url"
 /**
@@ -220,6 +244,8 @@
  * TOTEM_PL_PARSER_FIELD_IMAGE_URI:
  *
  * Metadata field for an entry's thumbnail image URI.
+ *
+ * Since: 2.26
  **/
 #define TOTEM_PL_PARSER_FIELD_IMAGE_URI		"image-url"
 /**
@@ -227,6 +253,8 @@
  *
  * Metadata field for an entry's download URI. Only used if an alternate download
  * location is available for the entry.
+ *
+ * Since: 2.26
  **/
 #define TOTEM_PL_PARSER_FIELD_DOWNLOAD_URI	"download-url"
 /**
@@ -281,8 +309,7 @@
  *
  * The type of playlist a #TotemPlParser will parse.
  **/
-typedef enum
-{
+typedef enum {
 	TOTEM_PL_PARSER_PLS,
 	TOTEM_PL_PARSER_M3U,
 	TOTEM_PL_PARSER_M3U_DOS,
@@ -298,8 +325,7 @@
  * Allows you to differentiate between different
  * errors occurring during file operations in a #TotemPlParser.
  **/
-typedef enum
-{
+typedef enum {
 	TOTEM_PL_PARSER_ERROR_NO_DISC,
 	TOTEM_PL_PARSER_ERROR_MOUNT_FAILED
 } TotemPlParserError;
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]