From 6a54d828c448d19c9ef503239e5e3575b1a7332b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micka=C3=ABl=20R=C3=A9mond?= Date: Mon, 19 Feb 2007 15:02:28 +0000 Subject: [PATCH] * doc/api/*: Added Erlang documentation generation script (EJAB-188). * doc/version.tex: Updated. * src/ejabberd.app: Updated. SVN Revision: 733 --- ChangeLog | 4 +++ doc/api/Makefile | 17 +++++++++ doc/api/overview.edoc | 10 ++++++ doc/api/process-one.css | 80 +++++++++++++++++++++++++++++++++++++++++ doc/version.tex | 2 +- src/ejabberd.app | 2 +- 6 files changed, 113 insertions(+), 2 deletions(-) create mode 100644 doc/api/Makefile create mode 100644 doc/api/overview.edoc create mode 100644 doc/api/process-one.css diff --git a/ChangeLog b/ChangeLog index 64ec753d7..757784bb8 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,9 @@ 2007-02-19 Mickael Remond + * doc/api/*: Added Erlang documentation generation script (EJAB-188). + * doc/version.tex: Updated. + * src/ejabberd.app: Updated. + * src/odbc/pg.sql: last table, state column cannot be NULL (EJAB-191). * src/odbc/mysql.sql: likewise. * src/odbc/mssql.sql. likewise. diff --git a/doc/api/Makefile b/doc/api/Makefile new file mode 100644 index 000000000..66f399555 --- /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 000000000..55f7b1f68 --- /dev/null +++ b/doc/api/overview.edoc @@ -0,0 +1,10 @@ +@author Mickael Remond + [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 000000000..793d717aa --- /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; +} diff --git a/doc/version.tex b/doc/version.tex index f51f8de60..5883038ef 100644 --- a/doc/version.tex +++ b/doc/version.tex @@ -1,2 +1,2 @@ % ejabberd version (automatically generated). -\newcommand{\version}{1.1.2} +\newcommand{\version}{1.1.3} diff --git a/src/ejabberd.app b/src/ejabberd.app index ea87c9215..bd5433b89 100644 --- a/src/ejabberd.app +++ b/src/ejabberd.app @@ -2,7 +2,7 @@ {application, ejabberd, [{description, "ejabberd"}, - {vsn, "1.1.2"}, + {vsn, "1.1.3"}, {modules, [acl, configure, cyrsasl,