From 4549971954b8b67ed714048730060c9f66f4f56f Mon Sep 17 00:00:00 2001
From: Philip Chimento <philip@endlessm.com>
Date: Tue, 17 Sep 2013 16:47:30 -0700
Subject: 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]
---
 docs/reference/webhelper/Makefile.am.inc | 44 ++++++++++++++++++++++++++++++
 docs/reference/webhelper/eos.css.in      | 46 ++++++++++++++++++++++++++++++++
 2 files changed, 90 insertions(+)
 create mode 100644 docs/reference/webhelper/Makefile.am.inc
 create mode 100644 docs/reference/webhelper/eos.css.in

(limited to 'docs/reference/webhelper')

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
diff --git a/docs/reference/webhelper/eos.css.in b/docs/reference/webhelper/eos.css.in
new file mode 100644
index 0000000..7307859
--- /dev/null
+++ b/docs/reference/webhelper/eos.css.in
@@ -0,0 +1,46 @@
+* {
+    font-family: "Source Sans Pro";
+}
+
+p {
+    font-size: 16pt;
+    text-indent: 0;
+    margin-bottom: 1em;
+}
+
+.STitle,
+.CTitle,
+.CGroup .CTitle {
+    font-size: 18pt;
+}
+
+.CHeading {
+    font-size: 14pt;
+}
+
+.SMain td,
+.SClass td,
+.STable,
+.CDLEntry,
+.CDLDescription {
+    font-size: 12pt;
+}
+
+.ContentPage #Content,
+.IndexPage #Index {
+    margin-left: 55ex;
+}
+
+.ContentPage #Menu,
+.IndexPage #Menu {
+    font-size: 12pt;
+    width: 41ex;
+}
+
+.Prototype *,
+.prettyprint *,
+.CBody pre,
+.CDLEntry {
+    font-family: "DejaVu Sans Mono";
+    font-size: 13pt;
+}
\ No newline at end of file
-- 
cgit v1.2.1