From c7b845e657b1da27c44d37d93e51048abc2b36b4 Mon Sep 17 00:00:00 2001
From: Marco Pesenti Gritti <marco@src.gnome.org>
Date: Wed, 19 Nov 2003 20:14:05 +0000
Subject: *** empty log message ***

---
 doc/.cvsignore                       |  2 ++
 doc/reference-howto.txt              | 29 +++++++++++++++++++++++++++++
 doc/reference/tmpl/ephy-session.sgml |  2 --
 doc/reference/tmpl/ephy-shell.sgml   |  2 --
 4 files changed, 31 insertions(+), 4 deletions(-)
 create mode 100644 doc/.cvsignore
 create mode 100644 doc/reference-howto.txt

diff --git a/doc/.cvsignore b/doc/.cvsignore
new file mode 100644
index 000000000..282522db0
--- /dev/null
+++ b/doc/.cvsignore
@@ -0,0 +1,2 @@
+Makefile
+Makefile.in
diff --git a/doc/reference-howto.txt b/doc/reference-howto.txt
new file mode 100644
index 000000000..314eac714
--- /dev/null
+++ b/doc/reference-howto.txt
@@ -0,0 +1,29 @@
+If you want to document one of the epiphany files you can do it
+by the following steps:
+
+- Add documentation headers to the .c file public functions
+
+For example:
+
+/**
+ * ephy_session_autoresume:
+ * @session: a #EphySession
+ *
+ * Resume a crashed session when necessary (interactive)
+ *
+ * Return value: TRUE if at least a window has been opened
+ **/
+gboolean
+ephy_session_autoresume (EphySession *session)
+
+I dont think gtk-doc has a syntax document, though gtk is
+a good example to look at.
+
+- If it's a GObject add the get_type function and include
+the .h in doc/reference/epiphany.types.
+
+- Remove the .h from the IGNORE_HFILES section of
+doc/reference/Makefile.am
+
+- Build and commit both the modified .c and the sgml generated
+in doc/reference/tmpl
diff --git a/doc/reference/tmpl/ephy-session.sgml b/doc/reference/tmpl/ephy-session.sgml
index 03ba6989f..4b3e753a3 100644
--- a/doc/reference/tmpl/ephy-session.sgml
+++ b/doc/reference/tmpl/ephy-session.sgml
@@ -9,13 +9,11 @@ ephy-session
 
 </para>
 
-
 <!-- ##### SECTION See_Also ##### -->
 <para>
 
 </para>
 
-
 <!-- ##### FUNCTION ephy_session_get_active_window ##### -->
 <para>
 
diff --git a/doc/reference/tmpl/ephy-shell.sgml b/doc/reference/tmpl/ephy-shell.sgml
index 176490882..1badb7c15 100644
--- a/doc/reference/tmpl/ephy-shell.sgml
+++ b/doc/reference/tmpl/ephy-shell.sgml
@@ -9,13 +9,11 @@ ephy-shell
 
 </para>
 
-
 <!-- ##### SECTION See_Also ##### -->
 <para>
 
 </para>
 
-
 <!-- ##### MACRO EPHY_SHELL_TYPE_DEF ##### -->
 <para>
 
-- 
cgit v1.2.3