summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar Tom Willemse2013-12-13 01:58:12 +0100
committerGravatar Tom Willemse2013-12-13 01:58:12 +0100
commitea764a96923667d2e86f2be426f6a3d0d3abd743 (patch)
treebad399b94d8bef72418dc635c0b1642804ee56b9
parentd88ad750c22eefd4f65eb768d10a3d4e4d4e04f4 (diff)
downloadedocs-ea764a96923667d2e86f2be426f6a3d0d3abd743.tar.gz
edocs-ea764a96923667d2e86f2be426f6a3d0d3abd743.zip
Slight improvement of Commentary
-rw-r--r--edocs.el6
1 files changed, 5 insertions, 1 deletions
diff --git a/edocs.el b/edocs.el
index a80d5da..63718d8 100644
--- a/edocs.el
+++ b/edocs.el
@@ -21,7 +21,11 @@
;;; Commentary:
-;; Generate formatted description of a module.
+;; Generate formatted description of a module. Currently it makes a
+;; simple HTML export of the Commentary and all the docstrings in a
+;; file. It is meant to be used as a batch operation, like so:
+
+;; emacs -batch -l edocs.el -f edocs-generate-docs file.el
;;; Code: