mirrors/emacs
1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2025-12-06 06:20:55 -08:00
Code Issues Projects Releases Wiki Activity

Fix comment about conventions for Lisp files.

Browse source
This commit is contained in:
Dave Love 1999-09-04 11:25:13 +00:00
parent 41b9a9887c
commit b0f08a24a4
1 changed files with 6 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

9
lib-src/make-docfile.c
View file

@ -544,13 +544,16 @@ scan_c_file (filename, mode)
When we find that, we save it for the following defining-form, 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. 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 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 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 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. 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 from that, it is always the .elc file that we look at, and they are no
problem because byte-compiler output follows this convention. problem because byte-compiler output follows this convention.
The NAME and DOCSTRING are output. The NAME and DOCSTRING are output.