diff options
| author | Philip Withnall <philip.withnall@collabora.co.uk> | 2010-06-22 18:24:33 +0100 |
|---|---|---|
| committer | Philip Withnall <philip.withnall@collabora.co.uk> | 2010-06-22 18:24:33 +0100 |
| commit | 67a6e4412fd64d901daf611112526732eec4a09a (patch) | |
| tree | 893b328aac886e93889936c4adf0d521bc0f2b5b /docs | |
| parent | 1000fe0fce30bca343770d2cf8a488aeceb41cac (diff) | |
Add documentation support and stub documentation to Folks
Add valadoc documentation support in the build system, and add stub
documentation to the top level of all the classes in the Folks namespace, but
not the Folks.Backends namespace.
The documentation is generated in HTML format in docs/folks-0.1/ but isn't
distributed in the tarball.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/.gitignore | 1 | ||||
| -rw-r--r-- | docs/Makefile.am | 30 |
2 files changed, 31 insertions, 0 deletions
diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..3345521 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1 @@ +folks-0.1 diff --git a/docs/Makefile.am b/docs/Makefile.am new file mode 100644 index 0000000..4c29331 --- /dev/null +++ b/docs/Makefile.am @@ -0,0 +1,30 @@ +docdir=$(datadir)/devhelp/references/folks-0.1 +innerdocdir=$(datadir)/devhelp/references/folks-0.1/folks-0.1 +imgdir=$(datadir)/devhelp/references/folks-0.1/folks-0.1/img + +doc_data = \ + folks-0.1/*.css \ + folks-0.1/*.png \ + $(NULL) + +doc_DATA = \ + folks-0.1/index.html \ + $(doc_data) \ + $(NULL) + +innerdoc_DATA = \ + folks-0.1/folks-0.1/index.htm \ + folks-0.1/folks-0.1/*.html \ + $(NULL) + +img_DATA = \ + folks-0.1/folks-0.1/img/*.png \ + $(NULL) + +$(doc_data) $(innerdoc_DATA) $(img_DATA): folks-0.1/index.html + +folks-0.1/index.html: + $(VALADOC) -o folks-0.1/ --force -b $(top_srcdir) \ + --pkg=gee-1.0 --pkg=gio-2.0 --pkg=gmodule-2.0 --pkg=build-conf \ + --vapidir=$(top_srcdir)/folks \ + $(top_srcdir)/folks/*.vala |