diff options
author | Ted Gould <ted@canonical.com> | 2009-02-03 14:25:53 +0100 |
---|---|---|
committer | Ted Gould <ted@canonical.com> | 2009-02-03 14:25:53 +0100 |
commit | 2f6177e8b934546b253bdf80d5b1ff073a19db49 (patch) | |
tree | 00d677c401768a97efb2dd02564dcfdc9018c60e /docs | |
parent | 7a916031c587dbf71e2d19978c2f54f162b58a48 (diff) | |
download | libayatana-indicator-2f6177e8b934546b253bdf80d5b1ff073a19db49.tar.gz libayatana-indicator-2f6177e8b934546b253bdf80d5b1ff073a19db49.tar.bz2 libayatana-indicator-2f6177e8b934546b253bdf80d5b1ff073a19db49.zip |
I think this will add gtk docs
Diffstat (limited to 'docs')
-rw-r--r-- | docs/reference/Makefile.am | 87 | ||||
-rw-r--r-- | docs/reference/libindicate.types | 6 | ||||
-rw-r--r-- | docs/reference/version.xml.in | 1 |
3 files changed, 94 insertions, 0 deletions
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am index e69de29..1bb6b68 100644 --- a/docs/reference/Makefile.am +++ b/docs/reference/Makefile.am @@ -0,0 +1,87 @@ +## Process this file with automake to produce Makefile.in + +# We require automake 1.6 at least. +AUTOMAKE_OPTIONS = 1.6 + +# This is a blank Makefile.am for using gtk-doc. +# Copy this to your project's API docs directory and modify the variables to +# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples +# of using the various options. + +# The name of the module, e.g. 'glib'. +DOC_MODULE=libindicate + +# The top-level SGML file. You can change this if you want to. +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 the functions and macros. +# e.g. DOC_SOURCE_DIR=../../../gtk +DOC_SOURCE_DIR=../../libindicate + +# Extra options to pass to gtkdoc-scangobj. Not normally needed. +SCANGOBJ_OPTIONS= + +# Extra options to supply to gtkdoc-scan. +# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED" +SCAN_OPTIONS= + +# Extra options to supply to gtkdoc-mkdb. +# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml +MKDB_OPTIONS=--sgml-mode --output-format=xml + +# Extra options to supply to gtkdoc-mktmpl +# e.g. MKTMPL_OPTIONS=--only-section-tmpl +MKTMPL_OPTIONS= + +# Extra options to supply to gtkdoc-fixref. Not normally needed. +# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html +FIXXREF_OPTIONS= + +# Used for dependencies. The docs will be rebuilt if any of these change. +# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h +# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c +HFILE_GLOB=$(top_srcdir)/libindicate/*.h +CFILE_GLOB=$(top_srcdir)/libindicate/*.c + +# Header files to ignore when scanning. +# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h +IGNORE_HFILES= + +# Images to copy into HTML directory. +# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png +HTML_IMAGES= + +# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). +# e.g. content_files=running.sgml building.sgml changes-2.0.sgml +content_files=version.xml + +# 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 +expand_content_files= + +# 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. +# e.g. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS) +# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib) +INCLUDES=-I$(top_builddir)/libindicate $(LIBINDICATE_CFLAGS) +GTKDOC_LIBS= + +# 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 += version.xml.in +EXTRA_DIST += version.xml.in + +# 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 +#DISTCLEANFILES += + +# Comment this out if you want your docs-status tested during 'make check' +#TESTS = $(GTKDOC_CHECK) + diff --git a/docs/reference/libindicate.types b/docs/reference/libindicate.types new file mode 100644 index 0000000..9c7b913 --- /dev/null +++ b/docs/reference/libindicate.types @@ -0,0 +1,6 @@ +#include <gtk/gtk.h> + +indicate_indicator_get_type +indicate_indicator_message_get_type +indicate_server_get_type +indicate_listener_get_type diff --git a/docs/reference/version.xml.in b/docs/reference/version.xml.in new file mode 100644 index 0000000..d78bda9 --- /dev/null +++ b/docs/reference/version.xml.in @@ -0,0 +1 @@ +@VERSION@ |