[libgfbgraph] doc: Just the skeleton to build the documentation



commit 3b5c3f341fe1470a8765f5e6ce4dbc97c8e2faff
Author: Álvaro Peña <alvaropg gmail com>
Date:   Tue Dec 10 22:38:29 2013 +0100

    doc: Just the skeleton to build the documentation

 docs/reference/gfbgraph-docs.xml     |   44 +++++++++
 docs/reference/gfbgraph-sections.txt |  176 ++++++++++++++++++++++++++++++++++
 docs/reference/gfbgraph.types        |    8 ++
 3 files changed, 228 insertions(+), 0 deletions(-)
---
diff --git a/docs/reference/gfbgraph-docs.xml b/docs/reference/gfbgraph-docs.xml
new file mode 100644
index 0000000..a5b00cc
--- /dev/null
+++ b/docs/reference/gfbgraph-docs.xml
@@ -0,0 +1,44 @@
+<?xml version="1.0"?>
+<!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'">
+]>
+<book id="index">
+  <bookinfo>
+    <title>gfbgraph Reference Manual</title>
+    <releaseinfo>
+      for gfbgraph [VERSION].
+      The latest version of this documentation can be found on-line at
+      <ulink role="online-location" 
url="http://[SERVER]/gfbgraph/index.html";>http://[SERVER]/gfbgraph/</ulink>.
+    </releaseinfo>
+  </bookinfo>
+
+  <chapter>
+    <title>[Insert title here]</title>
+        <xi:include href="xml/gfbgraph-album.xml"/>
+    <xi:include href="xml/gfbgraph-authorizer.xml"/>
+    <xi:include href="xml/gfbgraph-common.xml"/>
+    <xi:include href="xml/gfbgraph-connectable.xml"/>
+    <xi:include href="xml/gfbgraph-goa-authorizer.xml"/>
+    <xi:include href="xml/gfbgraph-node.xml"/>
+    <xi:include href="xml/gfbgraph-photo.xml"/>
+    <xi:include href="xml/gfbgraph-simple-authorizer.xml"/>
+    <xi:include href="xml/gfbgraph-user.xml"/>
+
+  </chapter>
+  <chapter id="object-tree">
+    <title>Object Hierarchy</title>
+     <xi:include href="xml/tree_index.sgml"/>
+  </chapter>
+  <index id="api-index-full">
+    <title>API Index</title>
+    <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
+  </index>
+  <index id="deprecated-api-index" role="deprecated">
+    <title>Index of deprecated API</title>
+    <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
+  </index>
+
+  <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
+</book>
diff --git a/docs/reference/gfbgraph-sections.txt b/docs/reference/gfbgraph-sections.txt
new file mode 100644
index 0000000..2b8da6b
--- /dev/null
+++ b/docs/reference/gfbgraph-sections.txt
@@ -0,0 +1,176 @@
+<SECTION>
+<FILE>gfbgraph-album</FILE>
+<TITLE>GFBGraphAlbum</TITLE>
+GFBGraphAlbum
+GFBGraphAlbumClass
+gfbgraph_album_new
+gfbgraph_album_new_from_id
+gfbgraph_album_get_name
+gfbgraph_album_get_description
+gfbgraph_album_get_cover_photo_id
+gfbgraph_album_get_count
+<SUBSECTION Standard>
+GFBGRAPH_ALBUM
+GFBGRAPH_ALBUM_CLASS
+GFBGRAPH_ALBUM_GET_CLASS
+GFBGRAPH_IS_ALBUM
+GFBGRAPH_IS_ALBUM_CLASS
+GFBGRAPH_TYPE_ALBUM
+GFBGraphAlbumPrivate
+gfbgraph_album_get_type
+</SECTION>
+
+<SECTION>
+<FILE>gfbgraph-authorizer</FILE>
+<TITLE>GFBGraphAuthorizer</TITLE>
+GFBGraphAuthorizerInterface
+gfbgraph_authorizer_process_call
+gfbgraph_authorizer_process_message
+gfbgraph_authorizer_refresh_authorization
+<SUBSECTION Standard>
+GFBGRAPH_AUTHORIZER
+GFBGRAPH_AUTHORIZER_GET_IFACE
+GFBGRAPH_IS_AUTHORIZER
+GFBGRAPH_TYPE_AUTHORIZER
+gfbgraph_authorizer_get_type
+</SECTION>
+
+<SECTION>
+<FILE>gfbgraph-common</FILE>
+gfbgraph_new_rest_call
+</SECTION>
+
+<SECTION>
+<FILE>gfbgraph-connectable</FILE>
+<TITLE>GFBGraphConnectable</TITLE>
+GFBGraphConnectableInterface
+gfbgraph_connectable_get_connection_post_params
+gfbgraph_connectable_parse_connected_data
+gfbgraph_connectable_is_connectable_to
+gfbgraph_connectable_get_connection_path
+gfbgraph_connectable_default_parse_connected_data
+<SUBSECTION Standard>
+GFBGRAPH_CONNECTABLE
+GFBGRAPH_CONNECTABLE_CLASS
+GFBGRAPH_CONNECTABLE_GET_IFACE
+GFBGRAPH_IS_CONNECTABLE
+GFBGRAPH_TYPE_CONNECTABLE
+gfbgraph_connectable_get_type
+</SECTION>
+
+<SECTION>
+<FILE>gfbgraph-goa-authorizer</FILE>
+<TITLE>GFBGraphGoaAuthorizer</TITLE>
+GFBGraphGoaAuthorizer
+GFBGraphGoaAuthorizerClass
+gfbgraph_goa_authorizer_new
+<SUBSECTION Standard>
+GFBGRAPH_GOA_AUTHORIZER
+GFBGRAPH_GOA_AUTHORIZER_CLASS
+GFBGRAPH_GOA_AUTHORIZER_GET_CLASS
+GFBGRAPH_IS_GOA_AUTHORIZER
+GFBGRAPH_IS_GOA_AUTHORIZER_CLASS
+GFBGRAPH_TYPE_GOA_AUTHORIZER
+GFBGraphGoaAuthorizerPrivate
+gfbgraph_goa_authorizer_get_type
+</SECTION>
+
+<SECTION>
+<FILE>gfbgraph-node</FILE>
+<TITLE>GFBGraphNode</TITLE>
+GFBGRAPH_NODE_ERROR
+GFBGraphNode
+GFBGraphNodeClass
+GFBGraphNodeError
+gfbgraph_node_error_quark
+gfbgraph_node_new
+gfbgraph_node_new_from_id
+gfbgraph_node_get_id
+gfbgraph_node_get_link
+gfbgraph_node_get_created_time
+gfbgraph_node_get_updated_time
+gfbgraph_node_get_connection_nodes
+gfbgraph_node_get_connection_nodes_async
+gfbgraph_node_get_connection_nodes_async_finish
+gfbgraph_node_append_connection
+<SUBSECTION Standard>
+GFBGRAPH_IS_NODE
+GFBGRAPH_IS_NODE_CLASS
+GFBGRAPH_NODE
+GFBGRAPH_NODE_CLASS
+GFBGRAPH_NODE_GET_CLASS
+GFBGRAPH_TYPE_NODE
+GFBGraphNodePrivate
+gfbgraph_node_get_type
+</SECTION>
+
+<SECTION>
+<FILE>gfbgraph-photo</FILE>
+<TITLE>GFBGraphPhoto</TITLE>
+GFBGraphPhoto
+GFBGraphPhotoClass
+GFBGraphPhotoImage
+gfbgraph_photo_new
+gfbgraph_photo_new_from_id
+gfbgraph_photo_download_default_size
+gfbgraph_photo_get_name
+gfbgraph_photo_get_default_source_uri
+gfbgraph_photo_get_default_width
+gfbgraph_photo_get_default_height
+gfbgraph_photo_get_images
+gfbgraph_photo_get_image_hires
+gfbgraph_photo_get_image_near_width
+gfbgraph_photo_get_image_near_height
+<SUBSECTION Standard>
+GFBGRAPH_IS_PHOTO
+GFBGRAPH_IS_PHOTO_CLASS
+GFBGRAPH_PHOTO
+GFBGRAPH_PHOTO_CLASS
+GFBGRAPH_PHOTO_GET_CLASS
+GFBGRAPH_TYPE_PHOTO
+GFBGraphPhotoPrivate
+gfbgraph_photo_get_type
+</SECTION>
+
+<SECTION>
+<FILE>gfbgraph-simple-authorizer</FILE>
+<TITLE>GFBGraphSimpleAuthorizer</TITLE>
+GFBGraphSimpleAuthorizer
+GFBGraphSimpleAuthorizerClass
+gfbgraph_simple_authorizer_new
+<SUBSECTION Standard>
+GFBGRAPH_IS_SIMPLE_AUTHORIZER
+GFBGRAPH_IS_SIMPLE_AUTHORIZER_CLASS
+GFBGRAPH_SIMPLE_AUTHORIZER
+GFBGRAPH_SIMPLE_AUTHORIZER_CLASS
+GFBGRAPH_SIMPLE_AUTHORIZER_GET_CLASS
+GFBGRAPH_TYPE_SIMPLE_AUTHORIZER
+GFBGraphSimpleAuthorizerPrivate
+gfbgraph_simple_authorizer_get_type
+</SECTION>
+
+<SECTION>
+<FILE>gfbgraph-user</FILE>
+<TITLE>GFBGraphUser</TITLE>
+GFBGraphUser
+GFBGraphUserClass
+gfbgraph_user_new
+gfbgraph_user_new_from_id
+gfbgraph_user_get_me
+gfbgraph_user_get_me_async
+gfbgraph_user_get_me_async_finish
+gfbgraph_user_get_albums
+gfbgraph_user_get_albums_async
+gfbgraph_user_get_albums_async_finish
+gfbgraph_user_get_name
+<SUBSECTION Standard>
+GFBGRAPH_IS_USER
+GFBGRAPH_IS_USER_CLASS
+GFBGRAPH_TYPE_USER
+GFBGRAPH_USER
+GFBGRAPH_USER_CLASS
+GFBGRAPH_USER_GET_CLASS
+GFBGraphUserPrivate
+gfbgraph_user_get_type
+</SECTION>
+
diff --git a/docs/reference/gfbgraph.types b/docs/reference/gfbgraph.types
new file mode 100644
index 0000000..a20c799
--- /dev/null
+++ b/docs/reference/gfbgraph.types
@@ -0,0 +1,8 @@
+gfbgraph_album_get_type
+gfbgraph_authorizer_get_type
+gfbgraph_connectable_get_type
+gfbgraph_goa_authorizer_get_type
+gfbgraph_node_get_type
+gfbgraph_photo_get_type
+gfbgraph_simple_authorizer_get_type
+gfbgraph_user_get_type


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]