summaryrefslogtreecommitdiff
path: root/src/doc.c
diff options
context:
space:
mode:
authorRichard M. Stallman <rms@gnu.org>2001-11-17 22:40:47 +0000
committerRichard M. Stallman <rms@gnu.org>2001-11-17 22:40:47 +0000
commitf4e25f94e79052cec557c895a912cefdc4c7a617 (patch)
treec8acf035b805cbcaad369397cb748bc8019104d7 /src/doc.c
parente35afc9744c14b12e0a9960ffb3278e3a31a2e1d (diff)
downloademacs-f4e25f94e79052cec557c895a912cefdc4c7a617.tar.gz
(Fsnarf_documentation): Doc fix.
Diffstat (limited to 'src/doc.c')
-rw-r--r--src/doc.c13
1 files changed, 7 insertions, 6 deletions
diff --git a/src/doc.c b/src/doc.c
index c17386bc979..be976909f61 100644
--- a/src/doc.c
+++ b/src/doc.c
@@ -462,12 +462,13 @@ store_function_docstring (fun, offset)
DEFUN ("Snarf-documentation", Fsnarf_documentation, Ssnarf_documentation,
1, 1, 0,
- doc: /* Used during Emacs initialization, before dumping runnable Emacs,
-to find pointers to doc strings stored in `etc/DOC...' and
-record them in function definitions.
-One arg, FILENAME, a string which does not include a directory.
-The file is found in `../etc' now; found in the `data-directory'
-when doc strings are referred to later in the dumped Emacs. */)
+ doc: /* Used during Emacs initialization to scan the `etc/DOC...' file.
+This searches the `etc/DOC...' file for doc strings and
+records them in function and variable definitions.
+The function takes one argument, FILENAME, a string;
+it specifies the file name (without a directory) of the DOC file.
+That file is found in `../etc' now; later, when the dumped Emacs is run,
+the same file name is found in the `data-directory'. */)
(filename)
Lisp_Object filename;
{