comparison lisp/emacs-lisp/autoload.el @ 39763:c8f0d7b4bb40

(doc-string-elt): Remove.
author Stefan Monnier <monnier@iro.umontreal.ca>
date Thu, 11 Oct 2001 01:49:29 +0000
parents a05ad383618d
children 0343ccd72be1
comparison
equal deleted inserted replaced
39762:db891c601a20 39763:c8f0d7b4bb40
29 ;; date. It interprets magic cookies of the form ";;;###autoload" in 29 ;; date. It interprets magic cookies of the form ";;;###autoload" in
30 ;; lisp source files in various useful ways. To learn more, read the 30 ;; lisp source files in various useful ways. To learn more, read the
31 ;; source; if you're going to use this, you'd better be able to. 31 ;; source; if you're going to use this, you'd better be able to.
32 32
33 ;;; Code: 33 ;;; Code:
34
35 (require 'lisp-mode) ;for `doc-string-elt' properties.
36
34 37
35 (defvar generated-autoload-file "loaddefs.el" 38 (defvar generated-autoload-file "loaddefs.el"
36 "*File \\[update-file-autoloads] puts autoloads into. 39 "*File \\[update-file-autoloads] puts autoloads into.
37 A `.el' file can set this in its local variables section to make its 40 A `.el' file can set this in its local variables section to make its
38 autoloads go somewhere else. The autoload file is assumed to contain a 41 autoloads go somewhere else. The autoload file is assumed to contain a
119 (t nil)))) 122 (t nil))))
120 123
121 ;;; Forms which have doc-strings which should be printed specially. 124 ;;; Forms which have doc-strings which should be printed specially.
122 ;;; A doc-string-elt property of ELT says that (nth ELT FORM) is 125 ;;; A doc-string-elt property of ELT says that (nth ELT FORM) is
123 ;;; the doc-string in FORM. 126 ;;; the doc-string in FORM.
124 ;;; 127 ;;; Those properties are now set in lisp-mode.el.
125 ;;; There used to be the following note here:
126 ;;; ;;; Note: defconst and defvar should NOT be marked in this way.
127 ;;; ;;; We don't want to produce defconsts and defvars that
128 ;;; ;;; make-docfile can grok, because then it would grok them twice,
129 ;;; ;;; once in foo.el (where they are given with ;;;###autoload) and
130 ;;; ;;; once in loaddefs.el.
131 ;;;
132 ;;; Counter-note: Yes, they should be marked in this way.
133 ;;; make-docfile only processes those files that are loaded into the
134 ;;; dumped Emacs, and those files should never have anything
135 ;;; autoloaded here. The above-feared problem only occurs with files
136 ;;; which have autoloaded entries *and* are processed by make-docfile;
137 ;;; there should be no such files.
138
139 (put 'autoload 'doc-string-elt 3)
140 (put 'defun 'doc-string-elt 3)
141 (put 'defun* 'doc-string-elt 3)
142 (put 'defvar 'doc-string-elt 3)
143 (put 'defcustom 'doc-string-elt 3)
144 (put 'defconst 'doc-string-elt 3)
145 (put 'defmacro 'doc-string-elt 3)
146 (put 'defsubst 'doc-string-elt 3)
147 (put 'define-skeleton 'doc-string-elt 2)
148 (put 'define-derived-mode 'doc-string-elt 4)
149 (put 'easy-mmode-define-minor-mode 'doc-string-elt 2)
150 (put 'define-minor-mode 'doc-string-elt 2)
151 (put 'define-generic-mode 'doc-string-elt 7)
152 ;; defin-global-mode has no explicit docstring.
153 (put 'easy-mmode-define-global-mode 'doc-string-elt 1000)
154 128
155 129
156 (defun autoload-trim-file-name (file) 130 (defun autoload-trim-file-name (file)
157 ;; Returns a relative pathname of FILE 131 ;; Returns a relative pathname of FILE
158 ;; starting from the directory that loaddefs.el is in. 132 ;; starting from the directory that loaddefs.el is in.