diff options
author | Philip Chimento <philip@endlessm.com> | 2013-09-17 16:47:30 -0700 |
---|---|---|
committer | Philip Chimento <philip@endlessm.com> | 2013-09-19 14:24:11 -0700 |
commit | 4549971954b8b67ed714048730060c9f66f4f56f (patch) | |
tree | 8643ba92fb425b0011c4468dbf76915eac989c83 /docs/reference/webhelper/Makefile.am.inc | |
parent | bf158e4986b6bf5570de2f6bd9de9e4be9b96608 (diff) |
Documentation for WebHelper
This adds the infrastructure for autogenerating HTML documentation from a
Javascript module using NaturalDocs, and then adds documentation comments
to webhelper.js.
[endlessm/eos-sdk#302]
Diffstat (limited to 'docs/reference/webhelper/Makefile.am.inc')
-rw-r--r-- | docs/reference/webhelper/Makefile.am.inc | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/docs/reference/webhelper/Makefile.am.inc b/docs/reference/webhelper/Makefile.am.inc new file mode 100644 index 0000000..0d99169 --- /dev/null +++ b/docs/reference/webhelper/Makefile.am.inc @@ -0,0 +1,44 @@ +if ENABLE_JS_DOC + +# This is for moving eos.css into the NaturalDocs project dir, which is in the +# build tree rather than the source tree. +docs/reference/webhelper/eos.css: docs/reference/webhelper/eos.css.in + $(AM_V_GEN)$(MKDIR_P) $(@D) + cp $< $@ + +docs/reference/webhelper/html/index.html: webhelper/webhelper.js docs/reference/webhelper/eos.css + $(MKDIR_P) $(@D) + naturaldocs -i $(<D) -o HTML $(@D) -p $(@D)/.. -s Default eos -hl All + +all-local: docs/reference/webhelper/html/index.html + +webhelper_docs_files = \ + docs/reference/webhelper/html/index.html \ + docs/reference/webhelper/html/files/webhelper-js.html \ + docs/reference/webhelper/html/index/Classes.html \ + docs/reference/webhelper/html/index/Functions.html \ + docs/reference/webhelper/html/index/General.html \ + docs/reference/webhelper/html/index/Properties.html \ + docs/reference/webhelper/html/javascript/main.js \ + docs/reference/webhelper/html/javascript/prettify.js \ + docs/reference/webhelper/html/javascript/searchdata.js \ + docs/reference/webhelper/html/search/*.html \ + docs/reference/webhelper/html/styles/*.css \ + $(NULL) +webhelper_extra_clean_files = \ + docs/reference/webhelper/Data/*.nd \ + docs/reference/webhelper/Menu.txt \ + docs/reference/webhelper/Topics.txt \ + docs/reference/webhelper/Languages.txt \ + docs/reference/webhelper/eos.css \ + $(NULL) +EXTRA_DIST += \ + $(webhelper_docs_files) \ + docs/reference/webhelper/eos.css.in \ + $(NULL) +CLEANFILES += \ + $(webhelper_docs_files) \ + $(webhelper_extra_clean_files) \ + $(NULL) + +endif |