diff options
author | Dave Love <fx@gnu.org> | 1999-09-04 11:25:13 +0000 |
---|---|---|
committer | Dave Love <fx@gnu.org> | 1999-09-04 11:25:13 +0000 |
commit | b0f08a24a45bd755ee88224ebff15f84233a31c6 (patch) | |
tree | b774909582da60fe881b2406b4a9f0fc16f2af91 /lib-src/make-docfile.c | |
parent | 41b9a9887c4d6aa14f67cb78b8cfe4d9e86ec200 (diff) | |
download | emacs-b0f08a24a45bd755ee88224ebff15f84233a31c6.tar.gz emacs-b0f08a24a45bd755ee88224ebff15f84233a31c6.tar.bz2 emacs-b0f08a24a45bd755ee88224ebff15f84233a31c6.zip |
Fix comment about conventions for Lisp files.
Diffstat (limited to 'lib-src/make-docfile.c')
-rw-r--r-- | lib-src/make-docfile.c | 9 |
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) When we find that, we save it for the following defining-form, and we use that instead of reading a doc string within that defining-form. - For defun, defmacro, and autoload, we know how to skip over the arglist. For defvar, defconst, and fset we skip to the docstring with a kludgy formatting convention: all docstrings must appear on the same line as the initial open-paren (the one in column zero) and must contain a backslash - and a double-quote immediately after the initial double-quote. No newlines + and a newline immediately after the initial double-quote. No newlines must appear between the beginning of the form and the first double-quote. - The only source file that must follow this convention is loaddefs.el; aside + For defun, defmacro, and autoload, we know how to skip over the + arglist, but the doc string must still have a backslash and newline + immediately after the double quote. + The only source files that must follow this convention are preloaded + uncompiled ones like loaddefs.el and bindings.el; aside from that, it is always the .elc file that we look at, and they are no problem because byte-compiler output follows this convention. The NAME and DOCSTRING are output. |