From 43c9869e242680ee45e868a6dfbc553e77b95a64 Mon Sep 17 00:00:00 2001
From: Ross Burton <ross@linux.intel.com>
Date: Wed, 4 Aug 2010 15:25:15 +0100
Subject: docs: merge rest-extras into rest

---
 docs/reference/Makefile.am                         |  2 +-
 docs/reference/rest-extras/Makefile.am             | 91 ---------------------
 docs/reference/rest-extras/rest-extras-docs.sgml   | 16 ----
 .../reference/rest-extras/rest-extras-sections.txt | 94 ----------------------
 docs/reference/rest-extras/rest-extras.types       |  4 -
 docs/reference/rest/Makefile.am                    |  8 +-
 docs/reference/rest/rest-docs.sgml                 | 13 ++-
 docs/reference/rest/rest-sections.txt              | 94 ++++++++++++++++++++++
 docs/reference/rest/rest.types                     | 17 ++--
 9 files changed, 122 insertions(+), 217 deletions(-)
 delete mode 100644 docs/reference/rest-extras/Makefile.am
 delete mode 100644 docs/reference/rest-extras/rest-extras-docs.sgml
 delete mode 100644 docs/reference/rest-extras/rest-extras-sections.txt
 delete mode 100644 docs/reference/rest-extras/rest-extras.types

(limited to 'docs')

diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
index 84e2cd9..b7e99c2 100644
--- a/docs/reference/Makefile.am
+++ b/docs/reference/Makefile.am
@@ -1 +1 @@
-SUBDIRS = rest rest-extras
+SUBDIRS = rest
diff --git a/docs/reference/rest-extras/Makefile.am b/docs/reference/rest-extras/Makefile.am
deleted file mode 100644
index d1ce68d..0000000
--- a/docs/reference/rest-extras/Makefile.am
+++ /dev/null
@@ -1,91 +0,0 @@
-## 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=rest-extras
-DOC_MODULE_VERSION=@API_VERSION@
-
-# The top-level SGML file. You can change this if you want to.
-DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
-
-# 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=../../../rest-extras
-
-# 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-mkhtml
-MKHTML_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)/rest-extras/*.h
-CFILE_GLOB=$(top_srcdir)/rest-extras/*.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=-I$(top_srcdir) -I$(top_builddir) $(GLIB_CFLAGS) $(SOUP_CFLAGS) $(XML_CFLAGS)
-GTKDOC_LIBS=$(top_builddir)/rest-extras/librest-extras-@API_VERSION@.la
-
-# 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 +=
-
-# Files not to distribute
-# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
-# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
-#DISTCLEANFILES +=
-
-# Comment this out if you want your docs-status tested during 'make check'
-#TESTS = $(GTKDOC_CHECK)
-
diff --git a/docs/reference/rest-extras/rest-extras-docs.sgml b/docs/reference/rest-extras/rest-extras-docs.sgml
deleted file mode 100644
index 9feb30a..0000000
--- a/docs/reference/rest-extras/rest-extras-docs.sgml
+++ /dev/null
@@ -1,16 +0,0 @@
-<?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>librest-extras Reference Manual</title>
- </bookinfo>
-
-  <chapter>
-    <title>REST Proxies</title>
-    <xi:include href="xml/flickr-proxy.xml"/>
-    <xi:include href="xml/flickr-proxy-call.xml"/>
-    <xi:include href="xml/lastfm-proxy.xml"/>
-    <xi:include href="xml/lastfm-proxy-call.xml"/>
-  </chapter>
-</book>
diff --git a/docs/reference/rest-extras/rest-extras-sections.txt b/docs/reference/rest-extras/rest-extras-sections.txt
deleted file mode 100644
index e071c14..0000000
--- a/docs/reference/rest-extras/rest-extras-sections.txt
+++ /dev/null
@@ -1,94 +0,0 @@
-<SECTION>
-<FILE>flickr-proxy-call</FILE>
-<TITLE>FlickrProxyCall</TITLE>
-FlickrProxyCall
-FlickrProxyCallClass
-<SUBSECTION Standard>
-FLICKR_PROXY_CALL
-FLICKR_IS_PROXY_CALL
-FLICKR_TYPE_PROXY_CALL
-flickr_proxy_call_get_type
-FLICKR_PROXY_CALL_CLASS
-FLICKR_IS_PROXY_CALL_CLASS
-FLICKR_PROXY_CALL_GET_CLASS
-</SECTION>
-
-<SECTION>
-<FILE>flickr-proxy</FILE>
-<TITLE>FlickrProxy</TITLE>
-FlickrProxyPrivate
-FlickrProxy
-FlickrProxyClass
-FLICKR_PROXY_ERROR
-flickr_proxy_new
-flickr_proxy_new_with_token
-flickr_proxy_get_api_key
-flickr_proxy_get_shared_secret
-flickr_proxy_get_token
-flickr_proxy_set_token
-flickr_proxy_sign
-flickr_proxy_build_login_url
-flickr_proxy_is_successful
-<SUBSECTION Standard>
-FLICKR_PROXY
-FLICKR_IS_PROXY
-FLICKR_TYPE_PROXY
-flickr_proxy_get_type
-FLICKR_PROXY_CLASS
-FLICKR_IS_PROXY_CLASS
-FLICKR_PROXY_GET_CLASS
-</SECTION>
-
-<SECTION>
-<FILE>lastfm-proxy-call</FILE>
-<TITLE>LastfmProxyCall</TITLE>
-LastfmProxyCall
-LastfmProxyCallClass
-<SUBSECTION Standard>
-LASTFM_PROXY_CALL
-LASTFM_IS_PROXY_CALL
-LASTFM_TYPE_PROXY_CALL
-lastfm_proxy_call_get_type
-LASTFM_PROXY_CALL_CLASS
-LASTFM_IS_PROXY_CALL_CLASS
-LASTFM_PROXY_CALL_GET_CLASS
-</SECTION>
-
-<SECTION>
-<FILE>lastfm-proxy</FILE>
-<TITLE>LastfmProxy</TITLE>
-LastfmProxyPrivate
-LastfmProxy
-LastfmProxyClass
-LASTFM_PROXY_ERROR
-lastfm_proxy_new
-lastfm_proxy_new_with_session
-lastfm_proxy_get_api_key
-lastfm_proxy_get_secret
-lastfm_proxy_get_session_key
-lastfm_proxy_set_session_key
-lastfm_proxy_sign
-lastfm_proxy_build_login_url
-lastfm_proxy_is_successful
-<SUBSECTION Standard>
-LASTFM_PROXY
-LASTFM_IS_PROXY
-LASTFM_TYPE_PROXY
-lastfm_proxy_get_type
-LASTFM_PROXY_CLASS
-LASTFM_IS_PROXY_CLASS
-LASTFM_PROXY_GET_CLASS
-</SECTION>
-
-<SECTION>
-<FILE>lastfm-proxy-private</FILE>
-PROXY_GET_PRIVATE
-LastfmProxyPrivate
-</SECTION>
-
-<SECTION>
-<FILE>flickr-proxy-private</FILE>
-PROXY_GET_PRIVATE
-FlickrProxyPrivate
-</SECTION>
-
diff --git a/docs/reference/rest-extras/rest-extras.types b/docs/reference/rest-extras/rest-extras.types
deleted file mode 100644
index e67f7be..0000000
--- a/docs/reference/rest-extras/rest-extras.types
+++ /dev/null
@@ -1,4 +0,0 @@
-flickr_proxy_get_type
-flickr_proxy_call_get_type
-lastfm_proxy_get_type
-lastfm_proxy_call_get_type
diff --git a/docs/reference/rest/Makefile.am b/docs/reference/rest/Makefile.am
index d43ded0..1d3947e 100644
--- a/docs/reference/rest/Makefile.am
+++ b/docs/reference/rest/Makefile.am
@@ -19,7 +19,7 @@ DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
 # 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=../../../rest
+DOC_SOURCE_DIR=../../../rest ../../../rest-extras
 
 # Extra options to pass to gtkdoc-scangobj. Not normally needed.
 SCANGOBJ_OPTIONS=
@@ -46,8 +46,8 @@ 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)/rest/*.h
-CFILE_GLOB=$(top_srcdir)/rest/*.c
+HFILE_GLOB=$(top_srcdir)/rest/*.h $(top_srcdir)/rest-extras/*.h
+CFILE_GLOB=$(top_srcdir)/rest/*.c $(top_srcdir)/rest-extras/*.c
 
 # Header files to ignore when scanning.
 # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
@@ -72,7 +72,7 @@ expand_content_files=
 # e.g. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
 # e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
 INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GLIB_CFLAGS) $(SOUP_CFLAGS) $(XML_CFLAGS)
-GTKDOC_LIBS=$(top_builddir)/rest/librest-@API_VERSION@.la
+GTKDOC_LIBS=$(top_builddir)/rest/librest-@API_VERSION@.la $(top_builddir)/rest-extras/librest-extras-@API_VERSION@.la
 
 # This includes the standard gtk-doc make rules, copied by gtkdocize.
 include $(top_srcdir)/gtk-doc.make
diff --git a/docs/reference/rest/rest-docs.sgml b/docs/reference/rest/rest-docs.sgml
index 9069bf8..18f0481 100644
--- a/docs/reference/rest/rest-docs.sgml
+++ b/docs/reference/rest/rest-docs.sgml
@@ -7,17 +7,28 @@
  </bookinfo>
 
   <chapter>
-    <title>REST Proxies</title>
+    <title>Generic Proxies</title>
     <xi:include href="xml/rest-param.xml"/>
     <xi:include href="xml/rest-params.xml"/>
     <xi:include href="xml/rest-proxy.xml"/>
     <xi:include href="xml/rest-proxy-call.xml"/>
+  </chapter>
+
+  <chapter>
+    <title>OAuth Proxies</title>
     <xi:include href="xml/oauth-proxy.xml"/>
     <xi:include href="xml/oauth-proxy-call.xml"/>
     <xi:include href="xml/oauth2-proxy.xml"/>
     <xi:include href="xml/oauth2-proxy-call.xml"/>
   </chapter>
 
+  <chapter>
+    <title>Service-specific Proxies</title>
+    <xi:include href="xml/flickr-proxy.xml"/>
+    <xi:include href="xml/flickr-proxy-call.xml"/>
+    <xi:include href="xml/lastfm-proxy.xml"/>
+    <xi:include href="xml/lastfm-proxy-call.xml"/>
+  </chapter>
   <chapter>
     <title>XML Parsing</title>
     <xi:include href="xml/rest-xml-parser.xml"/>
diff --git a/docs/reference/rest/rest-sections.txt b/docs/reference/rest/rest-sections.txt
index 0c67108..64a6178 100644
--- a/docs/reference/rest/rest-sections.txt
+++ b/docs/reference/rest/rest-sections.txt
@@ -209,3 +209,97 @@ rest_param_get_content_length
 rest_param_ref
 rest_param_unref
 </SECTION>
+<SECTION>
+<FILE>flickr-proxy-call</FILE>
+<TITLE>FlickrProxyCall</TITLE>
+FlickrProxyCall
+FlickrProxyCallClass
+<SUBSECTION Standard>
+FLICKR_PROXY_CALL
+FLICKR_IS_PROXY_CALL
+FLICKR_TYPE_PROXY_CALL
+flickr_proxy_call_get_type
+FLICKR_PROXY_CALL_CLASS
+FLICKR_IS_PROXY_CALL_CLASS
+FLICKR_PROXY_CALL_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>flickr-proxy</FILE>
+<TITLE>FlickrProxy</TITLE>
+FlickrProxyPrivate
+FlickrProxy
+FlickrProxyClass
+FLICKR_PROXY_ERROR
+flickr_proxy_new
+flickr_proxy_new_with_token
+flickr_proxy_get_api_key
+flickr_proxy_get_shared_secret
+flickr_proxy_get_token
+flickr_proxy_set_token
+flickr_proxy_sign
+flickr_proxy_build_login_url
+flickr_proxy_is_successful
+<SUBSECTION Standard>
+FLICKR_PROXY
+FLICKR_IS_PROXY
+FLICKR_TYPE_PROXY
+flickr_proxy_get_type
+FLICKR_PROXY_CLASS
+FLICKR_IS_PROXY_CLASS
+FLICKR_PROXY_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>lastfm-proxy-call</FILE>
+<TITLE>LastfmProxyCall</TITLE>
+LastfmProxyCall
+LastfmProxyCallClass
+<SUBSECTION Standard>
+LASTFM_PROXY_CALL
+LASTFM_IS_PROXY_CALL
+LASTFM_TYPE_PROXY_CALL
+lastfm_proxy_call_get_type
+LASTFM_PROXY_CALL_CLASS
+LASTFM_IS_PROXY_CALL_CLASS
+LASTFM_PROXY_CALL_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>lastfm-proxy</FILE>
+<TITLE>LastfmProxy</TITLE>
+LastfmProxyPrivate
+LastfmProxy
+LastfmProxyClass
+LASTFM_PROXY_ERROR
+lastfm_proxy_new
+lastfm_proxy_new_with_session
+lastfm_proxy_get_api_key
+lastfm_proxy_get_secret
+lastfm_proxy_get_session_key
+lastfm_proxy_set_session_key
+lastfm_proxy_sign
+lastfm_proxy_build_login_url
+lastfm_proxy_is_successful
+<SUBSECTION Standard>
+LASTFM_PROXY
+LASTFM_IS_PROXY
+LASTFM_TYPE_PROXY
+lastfm_proxy_get_type
+LASTFM_PROXY_CLASS
+LASTFM_IS_PROXY_CLASS
+LASTFM_PROXY_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>lastfm-proxy-private</FILE>
+PROXY_GET_PRIVATE
+LastfmProxyPrivate
+</SECTION>
+
+<SECTION>
+<FILE>flickr-proxy-private</FILE>
+PROXY_GET_PRIVATE
+FlickrProxyPrivate
+</SECTION>
+
diff --git a/docs/reference/rest/rest.types b/docs/reference/rest/rest.types
index 6ee6da9..97a392c 100644
--- a/docs/reference/rest/rest.types
+++ b/docs/reference/rest/rest.types
@@ -1,7 +1,12 @@
-rest_xml_parser_get_type
-rest_proxy_get_type
-rest_proxy_call_get_type
-oauth_proxy_get_type
-oauth_proxy_call_get_type
-oauth2_proxy_get_type
+flickr_proxy_call_get_type
+flickr_proxy_get_type
+lastfm_proxy_call_get_type
+lastfm_proxy_get_type
 oauth2_proxy_call_get_type
+oauth2_proxy_get_type
+oauth_proxy_call_get_type
+oauth_proxy_get_type
+rest_proxy_call_get_type
+rest_proxy_get_type
+rest_xml_node_get_type
+rest_xml_parser_get_type
-- 
cgit v1.2.1