summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAndrew Latham <lathama@gmail.com>2012-09-22 20:43:30 +0000
committerAndrew Latham <lathama@gmail.com>2012-09-22 20:43:30 +0000
commitfd98835f1fb45d2b745bd273a590cf488b4c11dd (patch)
tree6755c6c5fd972d7867a0595f4ac64d5d56acfdb8 /doc
parentca8aeeef1bead57973f91fce0e4ed239d73a00b3 (diff)
Doxygen Updates Janitor Work
* Whitespace, doc-blocks, spelling, case, missing and incorrect tags. * Add cleanup to Makefile for the Doxygen configuration update * Start updating Doxygen configuration for cleaner output * Enable inclusion of configuration files into documentation * remove mantisworkflow... * update documentation README * Add markup to Tilghman's email and talk with him about updating his email, he knows... * no code changes on this commit other than the mentioned Makefile change (issue ASTERISK-20259) git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@373384 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'doc')
-rw-r--r--doc/README.txt6
1 files changed, 5 insertions, 1 deletions
diff --git a/doc/README.txt b/doc/README.txt
index 68a87e11e..5adea8687 100644
--- a/doc/README.txt
+++ b/doc/README.txt
@@ -1,10 +1,14 @@
The vast majority of the Asterisk project documentation has been moved to the
project wiki:
- http://wiki.asterisk.org/
+ https://wiki.asterisk.org/
Asterisk release tarballs contain an export of the wiki in PDF and plain text
form, which you can find in:
doc/AST.pdf
doc/AST.txt
+
+Asterisk uses the Doxygen documentation software. Run "make progdocs" and open
+the resulting documentation index at doc/api/index.html in a webbrowser or copy
+the directory to a directory served by a webserver for remote access.