From 96644ef5c68b652b59c90caf246645d70a75fc3b Mon Sep 17 00:00:00 2001
From: Adam Hooper <adamh@src.gnome.org>
Date: Wed, 7 Apr 2004 20:14:20 +0000
Subject: Added forgotten EphyNodeDb documentation

---
 doc/reference/tmpl/ephy-node-db.sgml | 131 +++++++++++++++++++++++++++++++++++
 1 file changed, 131 insertions(+)
 create mode 100644 doc/reference/tmpl/ephy-node-db.sgml

(limited to 'doc/reference')

diff --git a/doc/reference/tmpl/ephy-node-db.sgml b/doc/reference/tmpl/ephy-node-db.sgml
new file mode 100644
index 000000000..ff753f80f
--- /dev/null
+++ b/doc/reference/tmpl/ephy-node-db.sgml
@@ -0,0 +1,131 @@
+<!-- ##### SECTION Title ##### -->
+EphyNodeDb
+
+<!-- ##### SECTION Short_Description ##### -->
+Data tree
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+An #EphyNodeDb is a database for arbitrary data organized in a tree.
+</para>
+<para>
+Each database is stored along with its name in a global set of databases.
+Databases can be created using ephy_node_db_new() and retrieved using
+ephy_node_db_get_by_name().
+</para>
+<para>
+Each #EphyNode inside an #EphyNodeDb is identified by a unique node ID. By
+keeping a handle on the ID, one can use ephy_node_db_get_node_from_id() to
+retrieve its corresponding #EphyNode.
+</para>
+<para>
+#EphyNodeDb<!-- -->s can be saved to disk using ephy_node_db_write_to_xml_safe()
+and restored using ephy_node_db_load_from_file().
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### STRUCT EphyNodeDb ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### FUNCTION ephy_node_db_get_by_name ##### -->
+<para>
+
+</para>
+
+@name: 
+@Returns: 
+
+
+<!-- ##### FUNCTION ephy_node_db_new ##### -->
+<para>
+
+</para>
+
+@name: 
+@Returns: 
+
+
+<!-- ##### FUNCTION ephy_node_db_load_from_file ##### -->
+<para>
+
+</para>
+
+@db: 
+@xml_file: 
+@xml_root: 
+@xml_version: 
+@Returns: 
+
+
+<!-- ##### FUNCTION ephy_node_db_write_to_xml_safe ##### -->
+<para>
+
+</para>
+
+@db: 
+@filename: 
+@root: 
+@version: 
+@comment: 
+@node: 
+@Varargs: 
+@Returns: 
+
+
+<!-- ##### FUNCTION ephy_node_db_get_name ##### -->
+<para>
+
+</para>
+
+@db: 
+@Returns: 
+
+
+<!-- ##### FUNCTION ephy_node_db_is_immutable ##### -->
+<para>
+
+</para>
+
+@db: 
+@Returns: 
+
+
+<!-- ##### FUNCTION ephy_node_db_set_immutable ##### -->
+<para>
+
+</para>
+
+@db: 
+@immutable: 
+
+
+<!-- ##### FUNCTION ephy_node_db_get_node_from_id ##### -->
+<para>
+
+</para>
+
+@db: 
+@id: 
+@Returns: 
+<!-- # Unused Parameters # -->
+@Param2: 
+
+
+<!-- ##### ARG EphyNodeDb:immutable ##### -->
+<para>
+%TRUE if no #EphyNode<!-- -->s can be added, removed or modified from this
+#EphyNodeDb
+</para>
+
+<!-- ##### ARG EphyNodeDb:name ##### -->
+<para>
+A string identifier unique to this #EphyNodeDb
+</para>
+
-- 
cgit v1.2.3