diff options
author | Eli Zaretskii <eliz@gnu.org> | 2019-07-28 17:31:17 +0300 |
---|---|---|
committer | Eli Zaretskii <eliz@gnu.org> | 2019-07-28 17:31:17 +0300 |
commit | 42e4fb8ae9514573639fcfff2b957fa88f3f7e84 (patch) | |
tree | 5d001b6de822e06d948dbc62d395794af6d2e59c /lisp/emacs-lisp | |
parent | efc6301068b53ab319aa6a8a1b5607273e4d5b17 (diff) | |
download | emacs-42e4fb8ae9514573639fcfff2b957fa88f3f7e84.tar.gz emacs-42e4fb8ae9514573639fcfff2b957fa88f3f7e84.tar.bz2 emacs-42e4fb8ae9514573639fcfff2b957fa88f3f7e84.zip |
; * lisp/emacs-lisp/derived.el (define-derived-mode): Doc fix.
Diffstat (limited to 'lisp/emacs-lisp')
-rw-r--r-- | lisp/emacs-lisp/derived.el | 41 |
1 files changed, 22 insertions, 19 deletions
diff --git a/lisp/emacs-lisp/derived.el b/lisp/emacs-lisp/derived.el index dc867d61da3..a6578e33086 100644 --- a/lisp/emacs-lisp/derived.el +++ b/lisp/emacs-lisp/derived.el @@ -113,9 +113,9 @@ ;;;###autoload (defmacro define-derived-mode (child parent name &optional docstring &rest body) - "Create a new mode as a variant of an existing mode. + "Create a new mode CHILD which is a variant of an existing mode PARENT. -The arguments to this command are as follow: +The arguments are as follows: CHILD: the name of the command for the derived mode. PARENT: the name of the command for the parent mode (e.g. `text-mode') @@ -123,25 +123,28 @@ PARENT: the name of the command for the parent mode (e.g. `text-mode') NAME: a string which will appear in the status line (e.g. \"Hypertext\") DOCSTRING: an optional documentation string--if you do not supply one, the function will attempt to invent something useful. -KEYWORDS: optional keywords. +KEYWORD-ARGS: + optional arguments in the form of pairs of keyword and value. + The following keyword arguments are currently supported: + + :group GROUP + Declare the customization group that corresponds + to this mode. The command `customize-mode' uses this. + :syntax-table TABLE + Use TABLE instead of the default (CHILD-syntax-table). + A nil value means to simply use the same syntax-table + as the parent. + :abbrev-table TABLE + Use TABLE instead of the default (CHILD-abbrev-table). + A nil value means to simply use the same abbrev-table + as the parent. + :after-hook FORM + A single lisp form which is evaluated after the mode + hooks have been run. It should not be quoted. + BODY: forms to execute just before running the hooks for the new mode. Do not use `interactive' here. -The following keywords are currently supported: - -:group GROUP - Declare the customization group that corresponds to this mode. - The command `customize-mode' uses this. -:syntax-table TABLE - Use TABLE instead of the default (CHILD-syntax-table). - A nil value means to simply use the same syntax-table as the parent. -:abbrev-table TABLE - Use TABLE instead of the default (CHILD-abbrev-table). - A nil value means to simply use the same abbrev-table as the parent. -:after-hook FORM - A single lisp form which is evaluated after the mode hooks have been - run. It should not be quoted. - Here is how you could define LaTeX-Thesis mode as a variant of LaTeX mode: (define-derived-mode LaTeX-thesis-mode LaTeX-mode \"LaTeX-Thesis\") @@ -165,7 +168,7 @@ The new mode runs the hook constructed by the function See Info node `(elisp)Derived Modes' for more details. -\(fn CHILD PARENT NAME [DOCSTRING] [KEYWORDS...] &rest BODY)" +\(fn CHILD PARENT NAME [DOCSTRING] [KEYWORD-ARGS...] &rest BODY)" (declare (debug (&define name symbolp sexp [&optional stringp] [&rest keywordp sexp] def-body)) (doc-string 4) |