aboutsummaryrefslogtreecommitdiffstats
path: root/src/doc.c
diff options
context:
space:
mode:
authorRichard M. Stallman2001-11-17 22:40:47 +0000
committerRichard M. Stallman2001-11-17 22:40:47 +0000
commitf4e25f94e79052cec557c895a912cefdc4c7a617 (patch)
treec8acf035b805cbcaad369397cb748bc8019104d7 /src/doc.c
parente35afc9744c14b12e0a9960ffb3278e3a31a2e1d (diff)
downloademacs-f4e25f94e79052cec557c895a912cefdc4c7a617.tar.gz
emacs-f4e25f94e79052cec557c895a912cefdc4c7a617.zip
(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)
462 462
463DEFUN ("Snarf-documentation", Fsnarf_documentation, Ssnarf_documentation, 463DEFUN ("Snarf-documentation", Fsnarf_documentation, Ssnarf_documentation,
464 1, 1, 0, 464 1, 1, 0,
465 doc: /* Used during Emacs initialization, before dumping runnable Emacs, 465 doc: /* Used during Emacs initialization to scan the `etc/DOC...' file.
466to find pointers to doc strings stored in `etc/DOC...' and 466This searches the `etc/DOC...' file for doc strings and
467record them in function definitions. 467records them in function and variable definitions.
468One arg, FILENAME, a string which does not include a directory. 468The function takes one argument, FILENAME, a string;
469The file is found in `../etc' now; found in the `data-directory' 469it specifies the file name (without a directory) of the DOC file.
470when doc strings are referred to later in the dumped Emacs. */) 470That file is found in `../etc' now; later, when the dumped Emacs is run,
471the same file name is found in the `data-directory'. */)
471 (filename) 472 (filename)
472 Lisp_Object filename; 473 Lisp_Object filename;
473{ 474{