path: root/docs/reference/endless/
diff options
authorPhilip Chimento <>2013-04-10 11:42:03 +0100
committerP. F. Chimento <>2013-04-17 17:15:52 +0200
commit6347c78610a7197e1d0cedd1a4a2136a595b5a67 (patch)
tree5eb4b408c6858fcff0b26b17d278682fabcdcb33 /docs/reference/endless/
parent5049b8938f407629690c6682263187986fb5f2ba (diff)
Autogenerate documentation with Gtk-doc
Run './configure --enable-gtk-doc' to turn on building documentation, or use --disable-gtk-doc to disable it (for faster builds.) It builds as part of the regular 'make' invocation, though you can use 'make docs' to build only the documentation. [#1]
Diffstat (limited to 'docs/reference/endless/')
1 files changed, 92 insertions, 0 deletions
diff --git a/docs/reference/endless/ b/docs/reference/endless/
new file mode 100644
index 0000000..a207921
--- /dev/null
+++ b/docs/reference/endless/
@@ -0,0 +1,92 @@
+## Process this file with automake to produce
+# The name of the module, e.g. 'glib'.
+# Uncomment for versioned docs and specify the version of the module, e.g. '2'.
+# The top-level SGML file. You can change this if you want to.
+# Directories containing the source code.
+# gtk-doc will search all .c and .h files beneath these paths
+# for inline comments documenting functions and macros.
+# e.g. DOC_SOURCE_DIR=$(top_srcdir)/gtk $(top_srcdir)/gdk
+# Extra options to pass to gtkdoc-scangobj. Not normally needed.
+# Extra options to supply to gtkdoc-scan.
+# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
+# Extra options to supply to gtkdoc-mkdb.
+# e.g. MKDB_OPTIONS=--xml-mode --output-format=xml
+MKDB_OPTIONS=--xml-mode --output-format=xml
+# Extra options to supply to gtkdoc-mktmpl
+# e.g. MKTMPL_OPTIONS=--only-section-tmpl
+# Extra options to supply to gtkdoc-mkhtml
+# Extra options to supply to gtkdoc-fixxref. Not normally needed.
+# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
+# Used for dependencies. The docs will be rebuilt if any of these change.
+# Extra header to include when scanning, which are not under DOC_SOURCE_DIR
+# e.g. EXTRA_HFILES=$(top_srcdir)/contrib/extra.h
+# Header files or dirs to ignore when scanning. Use base file/dir names
+# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h private_code
+# Images to copy into HTML directory.
+# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
+# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
+# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
+# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
+# These files must be listed here *and* in content_files
+# e.g. expand_content_files=running.sgml
+# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
+# Only needed if you are using gtkdoc-scangobj to dynamically query widget
+# signals and properties.
+GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) @EOS_SDK_CFLAGS@
+# This includes the standard gtk-doc make rules, copied by gtkdocize.
+include $(top_srcdir)/gtk-doc.make
+# Other files to distribute
+# e.g. EXTRA_DIST +=
+# Files not to distribute
+# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
+# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
+# Comment this out if you want 'make check' to test you doc status
+# and run some sanity checks
+TESTS_ENVIRONMENT = cd $(srcdir) && \
+ SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)