summaryrefslogtreecommitdiffstats
path: root/edocs.el
diff options
context:
space:
mode:
Diffstat (limited to 'edocs.el')
-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: