GNOME.org
 

soylent r277 - in trunk/docs/reference/libsoylent: . extra

Author: svenp
Date: Mon Aug 11 21:56:44 2008
New Revision: 277
URL: http://svn.gnome.org/viewvc/soylent?rev=277&view=rev

Log:
added extra chapters to documentation (stubs)
synchronized documentation with source-code

Added:
   trunk/docs/reference/libsoylent/extra/
   trunk/docs/reference/libsoylent/extra/libsoylent-architecture.sgml
   trunk/docs/reference/libsoylent/extra/libsoylent-attribute-mapping.sgml
   trunk/docs/reference/libsoylent/extra/libsoylent-examples.sgml
   trunk/docs/reference/libsoylent/extra/libsoylent-overview.sgml
Modified:
   trunk/docs/reference/libsoylent/   (props changed)
   trunk/docs/reference/libsoylent/Makefile.am
   trunk/docs/reference/libsoylent/libsoylent-docs.sgml
   trunk/docs/reference/libsoylent/libsoylent-sections.txt

Modified: trunk/docs/reference/libsoylent/Makefile.am
==============================================================================
--- trunk/docs/reference/libsoylent/Makefile.am	(original)
+++ trunk/docs/reference/libsoylent/Makefile.am	Mon Aug 11 21:56:44 2008
@@ -48,7 +48,7 @@
 
 # Header files to ignore when scanning.
 # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
-IGNORE_HFILES=sl-priv-util.h test.h
+IGNORE_HFILES=sl-priv-util.h test.h example.h
 
 # Images to copy into HTML directory.
 # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png

Added: trunk/docs/reference/libsoylent/extra/libsoylent-architecture.sgml
==============================================================================
--- (empty file)
+++ trunk/docs/reference/libsoylent/extra/libsoylent-architecture.sgml	Mon Aug 11 21:56:44 2008
@@ -0,0 +1,25 @@
+<?xml version="1.0"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd";>
+
+<refentry id="architecture">
+
+	<refmeta>
+		<refentrytitle>Architecture</refentrytitle>
+	</refmeta>
+	
+	<refnamediv>
+		<refname>Architecture</refname>
+		<refpurpose>architecture and implementation overview</refpurpose>
+	</refnamediv>
+
+	<refsect1>
+		<para>
+			The architecture of libsoylent...
+		</para>
+		<para>
+			another paragraph, bla, bla
+		</para>
+	</refsect1>
+
+</refentry>
+

Added: trunk/docs/reference/libsoylent/extra/libsoylent-attribute-mapping.sgml
==============================================================================
--- (empty file)
+++ trunk/docs/reference/libsoylent/extra/libsoylent-attribute-mapping.sgml	Mon Aug 11 21:56:44 2008
@@ -0,0 +1,25 @@
+<?xml version="1.0"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd";>
+
+<refentry id="attribute-mapping">
+
+	<refmeta>
+		<refentrytitle>Attribute-Mapping</refentrytitle>
+	</refmeta>
+	
+	<refnamediv>
+		<refname>Attribute-Mapping</refname>
+		<refpurpose>converting runtime-types to system-types</refpurpose>
+	</refnamediv>
+
+	<refsect1>
+		<para>
+			aaahaaaaaaaaa
+		</para>
+		<para>
+			oooohooooooooooo
+		</para>
+	</refsect1>
+
+</refentry>
+

Added: trunk/docs/reference/libsoylent/extra/libsoylent-examples.sgml
==============================================================================
--- (empty file)
+++ trunk/docs/reference/libsoylent/extra/libsoylent-examples.sgml	Mon Aug 11 21:56:44 2008
@@ -0,0 +1,25 @@
+<?xml version="1.0"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd";>
+
+<refentry id="examples">
+
+	<refmeta>
+		<refentrytitle>Examples</refentrytitle>
+	</refmeta>
+	
+	<refnamediv>
+		<refname>Examples</refname>
+		<refpurpose>code-examples for various tasks</refpurpose>
+	</refnamediv>
+
+	<refsect1>
+		<para>
+			oink
+		</para>
+		<para>
+			uuuunk
+		</para>
+	</refsect1>
+
+</refentry>
+

Added: trunk/docs/reference/libsoylent/extra/libsoylent-overview.sgml
==============================================================================
--- (empty file)
+++ trunk/docs/reference/libsoylent/extra/libsoylent-overview.sgml	Mon Aug 11 21:56:44 2008
@@ -0,0 +1,25 @@
+<?xml version="1.0"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd";>
+
+<refentry id="overview">
+
+	<refmeta>
+		<refentrytitle>Overview</refentrytitle>
+	</refmeta>
+	
+	<refnamediv>
+		<refname>Overview</refname>
+		<refpurpose>overview of libsoylent</refpurpose>
+	</refnamediv>
+
+	<refsect1>
+		<para>
+			mumumu
+		</para>
+		<para>
+			mamama
+		</para>
+	</refsect1>
+
+</refentry>
+

Modified: trunk/docs/reference/libsoylent/libsoylent-docs.sgml
==============================================================================
--- trunk/docs/reference/libsoylent/libsoylent-docs.sgml	(original)
+++ trunk/docs/reference/libsoylent/libsoylent-docs.sgml	Mon Aug 11 21:56:44 2008
@@ -5,22 +5,35 @@
   <bookinfo>
     <title>libsoylent Reference Manual</title>
     <releaseinfo>
-      for libsoylent v0.2.0
-      The latest version of this documentation can be found on-line at
+      for libsoylent v0.2.0; the latest version of this documentation can be found on-line at
       <ulink role="online-location" url="http://kalterregen.de/libsoylent/index.html";>http://kalterregen.de/libsoylent</ulink>.
     </releaseinfo>
   </bookinfo>
 
   <chapter>
-    <title>API documentation</title>
+    <title>libsoylent Concepts</title>
+    <xi:include href="extra/libsoylent-overview.sgml" />
+    <xi:include href="extra/libsoylent-attribute-mapping.sgml" />
+    <xi:include href="extra/libsoylent-examples.sgml" />
+  </chapter>
+
+  <chapter>
+    <title>libsoylent API Reference</title>
     <xi:include href="xml/soylent.xml"/>
     <xi:include href="xml/sl-book.xml"/>
     <xi:include href="xml/sl-entity.xml"/>
     <xi:include href="xml/sl-attribute.xml"/>
+    <xi:include href="xml/well-known-attributes.xml" />
     <xi:include href="xml/sl-person.xml"/>
     <!--<xi:include href="xml/sl-group.xml"/>
         <xi:include href="xml/sl-entity-handler.xml"/>
         <xi:include href="xml/sl-entity-handler-file.xml"/>
         <xi:include href="xml/sl-entity-handler-eds.xml"/>-->
   </chapter>
+
+  <chapter>
+    <title>Hacking libsoylent</title>
+    <xi:include href="extra/libsoylent-architecture.sgml" />
+  </chapter>
 </book>
+

Modified: trunk/docs/reference/libsoylent/libsoylent-sections.txt
==============================================================================
--- trunk/docs/reference/libsoylent/libsoylent-sections.txt	(original)
+++ trunk/docs/reference/libsoylent/libsoylent-sections.txt	Mon Aug 11 21:56:44 2008
@@ -1,84 +1,67 @@
 <SECTION>
 <FILE>sl-person</FILE>
 SL_PERSON_TYPE
-<TITLE>SlPerson</TITLE>
 SlPerson
 SlPersonClass
 sl_person_new
 sl_person_constr
+sl_person_add
+sl_person_add_attribute
+sl_person_commit
+sl_person_get
+sl_person_get_all
+sl_person_get_at
+sl_person_get_attribute
+sl_person_get_attributes
+sl_person_get_book
+sl_person_get_family_name
+sl_person_get_full_name
+sl_person_get_name
+sl_person_get_nick
+sl_person_has_attribute
+sl_person_modified
+sl_person_modified_at
+sl_person_remove_all
+sl_person_remove_at
+sl_person_remove_attribute
+sl_person_set
+sl_person_set_all
+sl_person_set_at
+sl_person_set_family_name
+sl_person_set_full_name
+sl_person_set_name
+sl_person_set_nick
 <SUBSECTION Standard>
 SL_PERSON
 SL_IS_PERSON
-sl_person_get_type
 SL_PERSON_CLASS
 SL_IS_PERSON_CLASS
 SL_PERSON_GET_CLASS
+sl_person_get_type
 <SUBSECTION Private>
 SlPersonPriv
+sl_person_new_with_econtact
+sl_person_constr_with_econtact
 </SECTION>
 
 <SECTION>
-<FILE>sl-group</FILE>
-SL_GROUP_TYPE
-SlGroupPriv
-<TITLE>SlGroup</TITLE>
-SlGroup
-SlGroupClass
-sl_group_new
-<SUBSECTION Standard>
-SL_GROUP
-SL_IS_GROUP
-sl_group_get_type
-SL_GROUP_CLASS
-SL_IS_GROUP_CLASS
-SL_GROUP_GET_CLASS
-</SECTION>
-
-<SECTION>
-<FILE>sl-attribute</FILE>
-<TITLE>Attributes and Attribute-Handlers</TITLE>
-SlAttribute
-SlAttributeClass
-sl_attribute_constr
-sl_attribute_new
-sl_attribute_set
-sl_attribute_get
-sl_attribute_set_at
-sl_attribute_get_at
-sl_attribute_remove_at
-sl_attribute_add
-sl_attribute_set_all
-sl_attribute_get_all
-sl_attribute_remove_all
-sl_attribute_get_name
-SlAttributeWriterFunc
-SlAttributeReaderFunc
-sl_attribute_writer_string
-sl_attribute_reader_string
-sl_attribute_writer_int
-sl_attribute_reader_int
-sl_entity_install_attribute_handler
-sl_entity_remove_attribute_handler
-<SUBSECTION Private>
-sl_attribute_handler_init
-sl_attribute_handler_cleanup
-sl_attribute_handler_write
-sl_attribute_handler_read
-SlAttributePriv
-SlAttributeHandler
+<FILE>sl-attribute-types</FILE>
+<TITLE>Attribute Types</TITLE>
+SlName
+SlAddress
+sl_name_new
+sl_address_new
+<SUBSECTION Private>
 <SUBSECTION Standard>
-sl_attribute_get_type
-SL_ATTRIBUTE_TYPE
-SL_ATTRIBUTE
-SL_ATTRIBUTE_CLASS
-SL_IS_ATTRIBUTE
-SL_IS_ATTRIBUTE_CLASS
-SL_ATTRIBUTE_GET_CLASS
 </SECTION>
 
 <SECTION>
 <FILE>sl-entity</FILE>
 <TITLE>SlEntity</TITLE>
+SlEntityCBAttributeAdded
+SlEntityCBAttributeModified
+SlEntityCBAttributeRemoved
+SlEntityCBModified
 SL_ENTITY_TYPE
 SlEntityPriv
 SlEntity
@@ -95,14 +78,24 @@
 sl_entity_get_attributes
 sl_entity_set
 sl_entity_get
-sl_entity_remove
 sl_entity_set_at
 sl_entity_get_at
 sl_entity_remove_at
-sl_entity_set_values
-sl_entity_get_values
-sl_entity_remove_values
+sl_entity_set_all
+sl_entity_get_all
+sl_entity_remove_all
+sl_entity_add
+sl_entity_get_storage
+sl_entity_has_attribute
+sl_entity_modified
+sl_entity_modified_at
 <SUBSECTION Private>
+sl_entity_add_attribute_shallow
+sl_entity_get_attribute_create
+sl_entity_get_attribute_from_eattr
+sl_entity_remove_attribute_shallow
+sl_entity_set_econtact
+sl_is_ignored_eattr
 <SUBSECTION Standard>
 SL_ENTITY
 SL_IS_ENTITY
@@ -113,72 +106,23 @@
 </SECTION>
 
 <SECTION>
-<FILE>sl-entity-handler</FILE>
-SL_ENTITY_HANDLER_TYPE
-<TITLE>SlEntityHandler</TITLE>
-SlEntityHandler
-SlEntityHandlerClass
-sl_entity_handler_get
-sl_entity_handler_set
-<SUBSECTION Standard>
-SL_ENTITY_HANDLER
-SL_IS_ENTITY_HANDLER
-sl_entity_handler_get_type
-SL_ENTITY_HANDLER_CLASS
-SL_IS_ENTITY_HANDLER_CLASS
-SL_ENTITY_HANDLER_GET_CLASS
-</SECTION>
-
-<SECTION>
-<FILE>sl-entity-handler-file</FILE>
-SL_ENTITY_HANDLER_FILE_TYPE
-SlEntityHandlerFilePriv
-<TITLE>SlEntityHandlerFile</TITLE>
-SlEntityHandlerFile
-SlEntityHandlerFileClass
-sl_entity_handler_file_new
-sl_entity_handler_file_get
-sl_entity_handler_file_set
-<SUBSECTION Standard>
-SL_ENTITY_HANDLER_FILE
-SL_IS_ENTITY_HANDLER_FILE
-sl_entity_handler_file_get_type
-SL_ENTITY_HANDLER_FILE_CLASS
-SL_IS_ENTITY_HANDLER_FILE_CLASS
-SL_ENTITY_HANDLER_FILE_GET_CLASS
-</SECTION>
-
-<SECTION>
-<FILE>sl-entity-handler-eds</FILE>
-SL_ENTITY_HANDLER_EDS_TYPE
-SlEntityHandlerEDSPriv
-<TITLE>SlEntityHandlerEDS</TITLE>
-SlEntityHandlerEDS
-SlEntityHandlerEDSClass
-sl_entity_handler_eds_new
-sl_entity_handler_eds_get
-sl_entity_handler_eds_set
-sl_entity_handler_eds_get_contact
-<SUBSECTION Standard>
-SL_ENTITY_HANDLER_EDS
-SL_IS_ENTITY_HANDLER_EDS
-sl_entity_handler_eds_get_type
-SL_ENTITY_HANDLER_EDS_CLASS
-SL_IS_ENTITY_HANDLER_EDS_CLASS
-SL_ENTITY_HANDLER_EDS_GET_CLASS
-</SECTION>
-
-<SECTION>
 <FILE>sl-book</FILE>
 <TITLE>SlBook</TITLE>
 SL_BOOK_TYPE
-SL_BOOK_ERROR
-SL_BOOK_DEFAULT
-SlBookPriv
 SlBook
 SlBookClass
-sl_book_error_quark
-sl_book_setup
+SL_BOOK_ERROR
+SL_BOOK_DEFAULT
+SlBookCBBookCreated
+SlBookCBBookDeleted
+SlBookCBModified
+SlBookCBPersonAdded
+SlBookCBPersonAttributeAdded
+SlBookCBPersonAttributeModified
+SlBookCBPersonAttributeRemoved
+SlBookCBPersonModified
+SlBookCBPersonRemoved
+sl_book_constr
 sl_book_get_books
 sl_book_exists
 sl_book_create
@@ -192,14 +136,150 @@
 <SUBSECTION Standard>
 SL_BOOK
 SL_IS_BOOK
-sl_book_get_type
 SL_BOOK_CLASS
 SL_IS_BOOK_CLASS
 SL_BOOK_GET_CLASS
+sl_book_get_type
+sl_book_error_quark
+<SUBSECTION Private>
+SlBookPriv
+sl_book_setup
+sl_book_emit_person_added
+sl_book_emit_person_attribute_added
+sl_book_emit_person_attribute_modified
+sl_book_emit_person_attribute_removed
+sl_book_emit_person_removed
 </SECTION>
 
 <SECTION>
 <FILE>soylent</FILE>
 sl_init
 sl_cleanup
+sl_marshal_VOID__OBJECT_BOOLEAN
+sl_marshal_VOID__OBJECT_OBJECT_BOOLEAN
+sl_marshal_VOID__OBJECT_OBJECT_POINTER_BOOLEAN
+<SUBSECTION Private>
+<SUBSECTION Standard>
+</SECTION>
+
+<SECTION>
+<FILE>sl-attribute</FILE>
+<TITLE>SlAttribute</TITLE>
+SL_ATTRIBUTE_TYPE
+SlAttribute
+SlAttributeClass
+sl_attribute_new
+sl_attribute_new_empty
+sl_attribute_new_with_values
+sl_attribute_constr
+sl_attribute_constr_with_values
+sl_attribute_set
+sl_attribute_get
+sl_attribute_set_at
+sl_attribute_get_at
+sl_attribute_remove_at
+sl_attribute_add
+sl_attribute_set_all
+sl_attribute_get_all
+sl_attribute_remove_all
+sl_attribute_get_name
+sl_attribute_modified
+sl_attribute_modified_at
+sl_attribute_get_value_count
+<SUBSECTION Private>
+SlAttributePriv
+sl_attribute_new_with_eattr
+sl_attribute_new_with_eattributes
+sl_attribute_constr_with_eattr
+sl_attribute_constr_with_eattributes
+sl_attribute_create_eattr
+sl_attribute_remove_all_emit
+sl_attribute_remove_at_emit
+sl_attribute_set_all_from_eattributes
+sl_attribute_set_at_emit
+sl_attribute_modified_at_emit
+sl_attribute_set_entity
+sl_attribute_name_to_eattrname
+sl_attribute_eattrname_to_name
+sl_attribute_update_eattributes
+sl_attribute_add_emit
+sl_attribute_add_from_eattr
+sl_attribute_emit_modified
+sl_attribute_get_eattributes
+sl_attribute_get_entity
+<SUBSECTION Standard>
+SL_ATTRIBUTE
+SL_ATTRIBUTE_CLASS
+SL_IS_ATTRIBUTE
+SL_IS_ATTRIBUTE_CLASS
+SL_ATTRIBUTE_GET_CLASS
+sl_attribute_get_type
+</SECTION>
+
+<SECTION>
+<FILE>sl-attributes</FILE>
+<TITLE>Attribute System and Mapping</TITLE>
+SL_ATTRIBUTE_READER_FUNC
+SL_ATTRIBUTE_WRITER_FUNC
+SL_ATTRIBUTE_TO_STRING_FUNC
+SlAttributeWriterFunc
+SlAttributeReaderFunc
+SlAttributeToStringFunc
+SlAttributeDef
+SlAttributeMapper
+sl_install_attribute
+sl_install_attribute_mapper
+sl_attribute_mapper_read
+sl_attribute_mapper_write
+sl_attribute_to_string
+sl_attribute_cleanup
+sl_attribute_writer_string
+sl_attribute_reader_string
+sl_attribute_writer_gint
+sl_attribute_reader_gint
+sl_attribute_writer_bytes
+sl_attribute_writer_gdate
+sl_attribute_writer_glist
+sl_attribute_writer_sladdress
+sl_attribute_writer_slname
+sl_attribute_reader_bytes
+sl_attribute_reader_gdate
+sl_attribute_reader_glist
+sl_attribute_reader_sladdress
+sl_attribute_reader_slname
+sl_attribute_sladdress_to_string
+sl_attribute_slname_to_string
+sl_attribute_string_to_string
+sl_attribute_gint_to_string
+sl_attribute_glist_to_string
+sl_attribute_gdate_to_string
+sl_attribute_bytes_to_string
+<SUBSECTION Private>
+sl_attributes_cleanup
+sl_attributes_init
+sl_attribute_default_to_string
+<SUBSECTION Standard>
+</SECTION>
+
+<SECTION>
+<FILE>well-known-attributes</FILE>
+<TITLE>Well-Known Attributes</TITLE>
+SL_ATTR_ADDRESS
+SL_ATTR_BIRTHDAY
+SL_ATTR_BLOG
+SL_ATTR_CALENDAR_URL
+SL_ATTR_EMAIL
+SL_ATTR_FREE_BUSY_URL
+SL_ATTR_FULL_NAME
+SL_ATTR_GROUP
+SL_ATTR_ICON
+SL_ATTR_ID
+SL_ATTR_JOB_ROLE
+SL_ATTR_JOB_TITLE
+SL_ATTR_NAME
+SL_ATTR_NICK
+SL_ATTR_NOTE
+SL_ATTR_PHOTO
+SL_ATTR_TELEPHONE
+SL_ATTR_URL
 </SECTION>
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]