comparison lisp/emacs-lisp/byte-run.el @ 86296:cd8648d81eb3

(declare-function): Doc fix.

86295:0849ea0c808f

(defmacro declare-function (fn file &optional arglist)
  "Tell the byte-compiler that function FN is defined, in FILE.
Optional ARGLIST is the argument list used by the function.  The
FILE argument is not used by the byte-compiler, but by the
`check-declare' package, which checks that FILE contains a
definition for FN.  FILE should be either absolute, or relative
to the location of the file containing the declaration.  ARGLIST
is used by both the byte-compiler and `check-declare' to check
for consistency.

Note that for the purposes of `check-declare', this statement
must be the first non-whitespace on a line, and everything up to
the end of FILE must be all on the same line.  For example:

86296:cd8648d81eb3

(defmacro declare-function (fn file &optional arglist)
  "Tell the byte-compiler that function FN is defined, in FILE.
Optional ARGLIST is the argument list used by the function.  The
FILE argument is not used by the byte-compiler, but by the
`check-declare' package, which checks that FILE contains a
definition for FN.  ARGLIST is used by both the byte-compiler and
`check-declare' to check for consistency.

FILE can be either a Lisp file (in which case the \".el\"
extension is optional), or a C file.  FILE should be either
absolute, or relative to the location of the file containing the
declaration (for a Lisp file), or to the Emacs \"src/\" directory
\(for a C file).

Note that for the purposes of `check-declare', this statement
must be the first non-whitespace on a line, and everything up to
the end of FILE must be all on the same line.  For example: