aboutsummaryrefslogtreecommitdiffstats
path: root/doc/reference
diff options
context:
space:
mode:
Diffstat (limited to 'doc/reference')
-rw-r--r--doc/reference/Makefile.am63
-rw-r--r--doc/reference/epiphany-docs.sgml49
-rw-r--r--doc/reference/epiphany.types19
3 files changed, 131 insertions, 0 deletions
diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am
new file mode 100644
index 000000000..f0810ec55
--- /dev/null
+++ b/doc/reference/Makefile.am
@@ -0,0 +1,63 @@
+## Process this file with automake to produce Makefile.in
+AUTOMAKE_OPTIONS = 1.6
+
+# The name of the module
+DOC_MODULE=epiphany
+
+# The top-level SGML file.
+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 functions and macros.
+DOC_SOURCE_DIR=../../lib
+
+# Extra options to supply to gtkdoc-scan.
+SCAN_OPTIONS=
+
+# Extra options to supply to gtkdoc-mkdb.
+MKDB_OPTIONS=--sgml-mode --output-format=xml
+
+# Extra options to supply to gtkdoc-fixref.
+FIXXREF_OPTIONS=
+
+# Used for dependencies.
+HFILE_GLOB=
+CFILE_GLOB=
+
+# Header files to ignore when scanning.
+IGNORE_HFILES=
+
+# Images to copy into HTML directory.
+HTML_IMAGES =
+
+# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
+content_files =
+
+# Other files to distribute.
+extra_files =
+
+# CFLAGS and LDFLAGS for compiling scan program. Only needed
+# if $(DOC_MODULE).types is non-empty.
+GTKDOC_CFLAGS = -I$(top_srcdir)/src \
+ -I$(top_srcdir)/lib \
+ -I$(top_srcdir)/lib/widgets \
+ -I$(top_srcdir)/embed \
+ -I$(top_srcdir)/embed/mozilla \
+ -I$(top_srcdir)/src/bookmarks \
+ $(EPIPHANY_DEPENDENCY_CFLAGS)
+
+GTKDOC_LIBS = \
+ $(top_builddir)/embed/libephyembed.la \
+ $(top_builddir)/lib/libephy.la \
+ $(top_builddir)/src/bookmarks/libephybookmarks.la \
+ $(top_builddir)/src/libephymain.la \
+ $(EPIPHANY_DEPENDENCY_LIBS)
+
+# If you need to override some of the declarations, place them in the
+# $(DOC_MODULE)-overrides.txt file and uncomment the second line here.
+DOC_OVERRIDES =
+
+# include common portion ...
+include $(top_srcdir)/gtk-doc.make
+
diff --git a/doc/reference/epiphany-docs.sgml b/doc/reference/epiphany-docs.sgml
new file mode 100644
index 000000000..bc8dbb8d8
--- /dev/null
+++ b/doc/reference/epiphany-docs.sgml
@@ -0,0 +1,49 @@
+<?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/2001/XInclude">
+ <bookinfo>
+ <title>[Insert name here] Reference Manual</title>
+ </bookinfo>
+
+ <chapter>
+ <title>[Insert title here]</title>
+ <xi:include href="xml/ephy-dialog.xml"/>
+ <xi:include href="xml/ephy-file-chooser.xml"/>
+ <xi:include href="xml/ephy-module-loader.xml"/>
+ <xi:include href="xml/ephy-node-db.xml"/>
+ <xi:include href="xml/ephy-node-filter.xml"/>
+ <xi:include href="xml/ephy-node.xml"/>
+ <xi:include href="xml/ephy-prefs.xml"/>
+ <xi:include href="xml/eggtreemultidnd.xml"/>
+ <xi:include href="xml/ephy-arrow-toolbutton.xml"/>
+ <xi:include href="xml/ephy-ellipsizing-label.xml"/>
+ <xi:include href="xml/ephy-location-entry.xml"/>
+ <xi:include href="xml/ephy-node-view.xml"/>
+ <xi:include href="xml/ephy-search-entry.xml"/>
+ <xi:include href="xml/ephy-spinner.xml"/>
+ <xi:include href="xml/ephy-tree-model-node.xml"/>
+ <xi:include href="xml/ephy-tree-model-sort.xml"/>
+ <xi:include href="xml/ephy-zoom-action.xml"/>
+ <xi:include href="xml/ephy-zoom-control.xml"/>
+ <xi:include href="xml/eel-gconf-extensions.xml"/>
+ <xi:include href="xml/ephy-bonobo-extensions.xml"/>
+ <xi:include href="xml/ephy-debug.xml"/>
+ <xi:include href="xml/ephy-dnd.xml"/>
+ <xi:include href="xml/ephy-file-helpers.xml"/>
+ <xi:include href="xml/ephy-glade.xml"/>
+ <xi:include href="xml/ephy-gui.xml"/>
+ <xi:include href="xml/ephy-langs.xml"/>
+ <xi:include href="xml/ephy-node-common.xml"/>
+ <xi:include href="xml/ephy-state.xml"/>
+ <xi:include href="xml/ephy-stock-icons.xml"/>
+ <xi:include href="xml/ephy-string.xml"/>
+ <xi:include href="xml/ephy-thread-helpers.xml"/>
+ <xi:include href="xml/ephy-zoom.xml"/>
+ <xi:include href="xml/ephy-marshal.xml"/>
+ <xi:include href="xml/egg-editable-toolbar.xml"/>
+ <xi:include href="xml/egg-toolbar-editor.xml"/>
+ <xi:include href="xml/egg-toolbars-model.xml"/>
+ <xi:include href="xml/ephy-cell-renderer-progress.xml"/>
+ </chapter>
+</book>
diff --git a/doc/reference/epiphany.types b/doc/reference/epiphany.types
new file mode 100644
index 000000000..18f11650f
--- /dev/null
+++ b/doc/reference/epiphany.types
@@ -0,0 +1,19 @@
+#include <ephy-dialog.h>
+#include <ephy-file-chooser.h>
+#include <ephy-module-loader.h>
+#include <ephy-node-db.h>
+#include <ephy-node-filter.h>
+#include <ephy-location-entry.h>
+#include <ephy-zoom-action.h>
+#include <ephy-zoom-control.h>
+#include <ephy-cell-renderer-progress.h>
+
+ephy_dialog_get_type
+ephy_file_chooser_get_type
+ephy_module_loader_get_type
+ephy_node_db_get_type
+ephy_node_filter_get_type
+ephy_location_entry_get_type
+ephy_zoom_action_get_type
+ephy_zoom_control_get_type
+ephy_cell_renderer_progress_get_type