aboutsummaryrefslogtreecommitdiffstats
path: root/lib-src
diff options
context:
space:
mode:
authorDave Love1999-09-04 11:25:13 +0000
committerDave Love1999-09-04 11:25:13 +0000
commitb0f08a24a45bd755ee88224ebff15f84233a31c6 (patch)
treeb774909582da60fe881b2406b4a9f0fc16f2af91 /lib-src
parent41b9a9887c4d6aa14f67cb78b8cfe4d9e86ec200 (diff)
downloademacs-b0f08a24a45bd755ee88224ebff15f84233a31c6.tar.gz
emacs-b0f08a24a45bd755ee88224ebff15f84233a31c6.zip
Fix comment about conventions for Lisp files.
Diffstat (limited to 'lib-src')
-rw-r--r--lib-src/make-docfile.c9
1 files changed, 6 insertions, 3 deletions
diff --git a/lib-src/make-docfile.c b/lib-src/make-docfile.c
index 55920ce6dc4..8e830dbd99f 100644
--- a/lib-src/make-docfile.c
+++ b/lib-src/make-docfile.c
@@ -544,13 +544,16 @@ scan_c_file (filename, mode)
544 When we find that, we save it for the following defining-form, 544 When we find that, we save it for the following defining-form,
545 and we use that instead of reading a doc string within that defining-form. 545 and we use that instead of reading a doc string within that defining-form.
546 546
547 For defun, defmacro, and autoload, we know how to skip over the arglist.
548 For defvar, defconst, and fset we skip to the docstring with a kludgy 547 For defvar, defconst, and fset we skip to the docstring with a kludgy
549 formatting convention: all docstrings must appear on the same line as the 548 formatting convention: all docstrings must appear on the same line as the
550 initial open-paren (the one in column zero) and must contain a backslash 549 initial open-paren (the one in column zero) and must contain a backslash
551 and a double-quote immediately after the initial double-quote. No newlines 550 and a newline immediately after the initial double-quote. No newlines
552 must appear between the beginning of the form and the first double-quote. 551 must appear between the beginning of the form and the first double-quote.
553 The only source file that must follow this convention is loaddefs.el; aside 552 For defun, defmacro, and autoload, we know how to skip over the
553 arglist, but the doc string must still have a backslash and newline
554 immediately after the double quote.
555 The only source files that must follow this convention are preloaded
556 uncompiled ones like loaddefs.el and bindings.el; aside
554 from that, it is always the .elc file that we look at, and they are no 557 from that, it is always the .elc file that we look at, and they are no
555 problem because byte-compiler output follows this convention. 558 problem because byte-compiler output follows this convention.
556 The NAME and DOCSTRING are output. 559 The NAME and DOCSTRING are output.