summaryrefslogtreecommitdiff
path: root/doc/api
diff options
context:
space:
mode:
authorMickaël Rémond <mickael.remond@process-one.net>2007-02-19 15:02:28 +0000
committerMickaël Rémond <mickael.remond@process-one.net>2007-02-19 15:02:28 +0000
commit6a54d828c448d19c9ef503239e5e3575b1a7332b (patch)
treeb27ecf539ad50d56fcbf0a93a554fb8f3f1b5855 /doc/api
parent* src/odbc/pg.sql: last table, state column cannot be NULL (EJAB-191). (diff)
* doc/api/*: Added Erlang documentation generation script (EJAB-188).
* doc/version.tex: Updated. * src/ejabberd.app: Updated. SVN Revision: 733
Diffstat (limited to 'doc/api')
-rw-r--r--doc/api/Makefile17
-rw-r--r--doc/api/overview.edoc10
-rw-r--r--doc/api/process-one.css80
3 files changed, 107 insertions, 0 deletions
diff --git a/doc/api/Makefile b/doc/api/Makefile
new file mode 100644
index 00000000..66f39955
--- /dev/null
+++ b/doc/api/Makefile
@@ -0,0 +1,17 @@
+APPNAME = ejabberd
+VSN = SVN
+
+DOCDIR=.
+SRCDIR=../../src
+
+.PHONY = all
+
+all: docs
+
+clean:
+ rm -f *.html
+ rm edoc-info
+
+docs:
+ erl -noshell -run edoc_run application \
+ "'$(APPNAME)'" '"$(SRCDIR)"' '[{dir,"$(DOCDIR)"},{packages, false},{todo,true},{private,true},{def,{vsn,"$(VSN)"}},{stylesheet,"process-one.css"},{overview,"$(DOCDIR)/overview.edoc"}]' -s init stop
diff --git a/doc/api/overview.edoc b/doc/api/overview.edoc
new file mode 100644
index 00000000..55f7b1f6
--- /dev/null
+++ b/doc/api/overview.edoc
@@ -0,0 +1,10 @@
+@author Mickael Remond <mickael.remond@process-one.net>
+ [http://www.process-one.net/]
+@copyright 2007 Process-one
+@version {@vsn}, {@date} {@time}
+@title ejabberd Development API Documentation
+
+@doc
+== Introduction ==
+
+TODO: Insert content from Jerome documentation.
diff --git a/doc/api/process-one.css b/doc/api/process-one.css
new file mode 100644
index 00000000..793d717a
--- /dev/null
+++ b/doc/api/process-one.css
@@ -0,0 +1,80 @@
+html, body {
+ font-family: Verdana, sans-serif;
+ color: #000;
+ background-color: #fff;
+}
+
+h1 {
+ color: #4a5389;
+ border-bottom: solid 1px #000;
+}
+
+h2 {
+ font-size: 24px;
+ text-align: right;
+ color: #4a5389;
+ border-bottom: 1px solid #000;
+}
+
+h3 {
+ font-size: 18px;
+ color: #900;
+}
+
+h4 {
+ font-size: 14px;
+ color: #000;
+}
+
+a[href] {
+ color: #4a5389;
+}
+
+a[href]:hover {
+ background-color: #ecefff;
+}
+
+p, li, dd {
+ text-align: justify;
+}
+
+li {
+ margin-top: 0.3em;
+}
+
+li:first-child {
+ margin-top: 0px;
+}
+
+blockquote {
+ color: #555;
+}
+
+caption {
+ font-style: italic;
+ color: #009;
+ text-align: left;
+ margin-left: 20px;
+}
+
+table[border="1"] {
+ border-collapse: collapse;
+ margin-bottom: 1em;
+}
+
+table[border="1"] td {
+ border: 1px solid #ddd;
+}
+
+pre, tt, code {
+ color: #461b7e;
+}
+
+pre {
+ margin-left: 1em;
+}
+
+pre em {
+ font-style: normal;
+ font-weight: bold;
+}