From: Jannis Pohlmann Date: Mon, 30 Jul 2012 13:45:54 +0000 (+0100) Subject: Add initial version of the reference manual templates X-Git-Tag: node-startup-controller-0.9.1~74 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=62ca6dc614df714ad1f964ed00fbc8431460915c;p=profile%2Fivi%2Fnode-startup-controller.git Add initial version of the reference manual templates Most of the chapters in this manual still need to be written but this is a start. --- diff --git a/configure.ac b/configure.ac index 8f1903a..e037621 100644 --- a/configure.ac +++ b/configure.ac @@ -141,6 +141,7 @@ common/Makefile docs/Makefile docs/reference/Makefile docs/reference/node-startup-controller/Makefile +docs/reference/node-startup-controller/version.xml legacy-app-handler/Makefile nsm-dummy/busconf/Makefile nsm-dummy/Makefile diff --git a/docs/reference/node-startup-controller/Makefile.am b/docs/reference/node-startup-controller/Makefile.am index ed1686b..1877c53 100644 --- a/docs/reference/node-startup-controller/Makefile.am +++ b/docs/reference/node-startup-controller/Makefile.am @@ -4,26 +4,29 @@ AUTOMAKE_OPTIONS = 1.6 # The name of the module, e.g. 'glib'. -DOC_MODULE='node-startup-controller' +DOC_MODULE=node-startup-controller # Uncomment for versioned docs and specify the version of the module, e.g. '2'. DOC_MODULE_VERSION=$(BOOT_MANAGER_VERSION) # The top-level SGML file. You can change this if you want to. -DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml +DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml # 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 -DOC_SOURCE_DIR=$(top_builddir)/boot-manager +DOC_SOURCE_DIR = \ + $(top_srcdir)/boot-manager \ + $(top_srcdir)/common \ + $(top_srcdir)/legacy-app-handler # 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= +SCAN_OPTIONS=--rebuild-sections --rebuild-types # Extra options to supply to gtkdoc-mkdb. # e.g. MKDB_OPTIONS=--xml-mode --output-format=xml @@ -43,8 +46,13 @@ 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= -CFILE_GLOB= +HFILE_GLOB = \ + $(top_srcdir)/boot-manager/*.h \ + $(top_srcdir)/common/*.h +CFILE_GLOB = \ + $(top_srcdir)/boot-manager/*.c \ + $(top_srcdir)/common/*.c \ + $(top_srcdir)/legacy-app-handler/*.c # Extra header to include when scanning, which are not under DOC_SOURCE_DIR # e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h @@ -60,7 +68,8 @@ 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= +content_files = \ + version.xml # SGML files where gtk-doc abbrevations (#GtkWidget) are expanded # These files must be listed here *and* in content_files @@ -80,12 +89,13 @@ include $(top_srcdir)/gtk-doc.make # Other files to distribute # e.g. EXTRA_DIST += version.xml.in -EXTRA_DIST += +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 += +DISTCLEANFILES = $(DOC_MODULE).types $(DOC_MODULE)-sections.txt # Comment this out if you want 'make check' to test you doc status # and run some sanity checks @@ -97,3 +107,6 @@ TESTS_ENVIRONMENT = cd $(srcdir) && \ endif -include $(top_srcdir)/git.mk + +# Required for make distcheck +dist-hook: all diff --git a/docs/reference/node-startup-controller/legacy-app-handler.xml b/docs/reference/node-startup-controller/legacy-app-handler.xml new file mode 100644 index 0000000..07da74f --- /dev/null +++ b/docs/reference/node-startup-controller/legacy-app-handler.xml @@ -0,0 +1,18 @@ + + + + + legacy-app-handler + + + + legacy-app-handler + + Helper binary for registering legacy apps with the GENIVI Node State Manager + + + + + diff --git a/docs/reference/node-startup-controller/node-startup-controller-docs.xml b/docs/reference/node-startup-controller/node-startup-controller-docs.xml new file mode 100644 index 0000000..7867f76 --- /dev/null +++ b/docs/reference/node-startup-controller/node-startup-controller-docs.xml @@ -0,0 +1,133 @@ + + +]> + + + + GENIVI Node Startup Controller Reference Manual + Version + + 2012 + GENIVI + + + + Ben + Brewer + +
ben.brewer@codethink.co.uk
+ + + + Francisco Redondo + Marchena + +
francisco.marchena@codethink.co.uk
+ + + + Jannis + Pohlmann + +
jannis.pohlmann@codethink.co.uk
+ + + + Jonathan + Maw + +
jonathan.maw@codethink.co.uk
+ + + + + + + Node Startup Controller Overview + + Purpose of the Reference Manual + + The purpose of this reference manual is to provide documentation about the public + API of the Node Startup Controller as well as to give an overview of the classes + used in the implementation internally. + + + The intended readers of the reference manual are developers of GENIVI components + that interact with the Node Startup Controller and people who want to contribute + to the Node Startup Controller development. Reading this reference manual will + will help them to understand how the Node Startup Controller can be used and how + it is organised internally. + + + + Functional Overview + + + Public API Overview + + + Software Architecture + + + + + Building, Installing and Testing the Node Startup Controller + + Building + + + Installing + + + Testing + + + + + Public API + + + + + + Main Classes of the Node Startup Controller + + + + + + + + + + Generated D-Bus Classes + + + + + + + + + + Utilities + + + + + + + + API Index + + + + + + + + + diff --git a/docs/reference/node-startup-controller/version.xml.in b/docs/reference/node-startup-controller/version.xml.in new file mode 100644 index 0000000..d78bda9 --- /dev/null +++ b/docs/reference/node-startup-controller/version.xml.in @@ -0,0 +1 @@ +@VERSION@