From 891b34e2ef64f354474c4c6bec8e35f905e3c1db Mon Sep 17 00:00:00 2001 From: Guido Günther Date: Fri, 21 Feb 2014 15:57:11 +0100 Subject: Initial commit --- docs/Makefile.am | 1 + docs/reference/Makefile.am | 70 ++++++++++++++++++++++++++++++++ docs/reference/build-howto.xml | 58 ++++++++++++++++++++++++++ docs/reference/libplanfahr-0.0-docs.sgml | 32 +++++++++++++++ 4 files changed, 161 insertions(+) create mode 100644 docs/Makefile.am create mode 100644 docs/reference/Makefile.am create mode 100644 docs/reference/build-howto.xml create mode 100644 docs/reference/libplanfahr-0.0-docs.sgml (limited to 'docs') diff --git a/docs/Makefile.am b/docs/Makefile.am new file mode 100644 index 0000000..f3ddc22 --- /dev/null +++ b/docs/Makefile.am @@ -0,0 +1 @@ +SUBDIRS = reference diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am new file mode 100644 index 0000000..0f77dbb --- /dev/null +++ b/docs/reference/Makefile.am @@ -0,0 +1,70 @@ +## Process this file with automake to produce Makefile.in +AUTOMAKE_OPTIONS = 1.6 + +# The name of the module +DOC_MODULE=libplanfahr-0.0 + +# 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=../../src + +# Extra options to supply to gtkdoc-scan. +SCAN_OPTIONS='--rebuild-types' + +# Extra options to supply to gtkdoc-scangobj. +SCANGOBJ_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 = \ + planfahr.h \ + de-db.h \ + hafas-bin6.h \ + $(NULL) + +# Images to copy into HTML directory. +HTML_IMAGES = + +# Extra XML files that are included by $(DOC_MAIN_SGML_FILE). +content_files = \ + build-howto.xml \ + $(NULL) + +# 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) \ + -I$(top_builddir) \ + $(GLIB_CFLAGS) \ + $(XML_CFLAGS) \ + $(NULL) + +GTKDOC_LIBS = \ + $(top_builddir)/src/libplanfahr-0.0.la \ + $(GLIB_LIBS) + +# include common portion ... +include $(top_srcdir)/gtk-doc.make + +# kludges +$(srcdir)/tmpl/*.sgml: + +clean: clean-am + rm -rf tmpl diff --git a/docs/reference/build-howto.xml b/docs/reference/build-howto.xml new file mode 100644 index 0000000..e0922a1 --- /dev/null +++ b/docs/reference/build-howto.xml @@ -0,0 +1,58 @@ + + + + +Compiling with libplanfahr +3 +LIBPLANFAHR Library + + + +Compiling with libplanfahrNotes on compiling + + + +Using pkg-config + + +Like other GNOME libraries, libplanfahr uses +pkg-config to provide compiler options. The +package name is "libplanfahr-0.0". So in your +configure script, you might specify something like: + + + +PKG_CHECK_MODULES(LIBPLANFAHR, [libplanfahr-0.0]) +AC_SUBST(LIBPLANFAHR_CFLAGS) +AC_SUBST(LIBPLANFAHR_LIBS) + + + +The "0.0" in the package name is the "API version" +(indicating "the version of the libplanfahr API +that first appeared in version 0.0") and is essentially just part of +the package name. + + + + + +Headers + + +Code using libplanfahr should do: + + + +#include <libplanfahr/planfahr.h> + + + +Including individual headers rather than planfahr.h is not +recommended. + + + + + diff --git a/docs/reference/libplanfahr-0.0-docs.sgml b/docs/reference/libplanfahr-0.0-docs.sgml new file mode 100644 index 0000000..db2b5f8 --- /dev/null +++ b/docs/reference/libplanfahr-0.0-docs.sgml @@ -0,0 +1,32 @@ + + + + + libplanfahr Reference Manual + + + + Tutorial + + + + + Core API + + + + + + + + + + Index + + + + + + + -- cgit v1.2.3