Mercurial > emacs
changeset 47788:1174e4c84d58
(define-minor-mode): Doc fix.
| author | Richard M. Stallman <rms@gnu.org> |
|---|---|
| date | Mon, 07 Oct 2002 22:49:39 +0000 |
| parents | 1207b03521f9 |
| children | d43916bc2d4f |
| files | lisp/emacs-lisp/easy-mmode.el |
| diffstat | 1 files changed, 14 insertions(+), 5 deletions(-) [+] |
line wrap: on
line diff
--- a/lisp/emacs-lisp/easy-mmode.el Mon Oct 07 22:48:47 2002 +0000 +++ b/lisp/emacs-lisp/easy-mmode.el Mon Oct 07 22:49:39 2002 +0000 @@ -88,14 +88,23 @@ BODY contains code that will be executed each time the mode is (dis)activated. It will be executed after any toggling but before running the hooks. - BODY can start with a list of CL-style keys specifying additional arguments. - The following keyword arguments are supported: -:group GROUP Group name to use for any generated `defcustom'. + Before the actual body code, you can write + keyword arguments (alternating keywords and values). + These following keyword arguments are supported: +:group GROUP Custom group name to use in all generated `defcustom' forms. :global GLOBAL If non-nil specifies that the minor mode is not meant to be - buffer-local. By default, the variable is made buffer-local. + buffer-local, so don't make the variable MODE buffer-local. + By default, the mode is buffer-local. :init-value VAL Same as the INIT-VALUE argument. :lighter SPEC Same as the LIGHTER argument. -:require SYM Same as defcustom's :require argument." +:require SYM Same as in `defcustom'. + +For example, you could write + (define-minor-mode foo-mode \"If enabled, foo on you!\" + nil \"Foo \" foo-keymap + :require 'foo :global t :group 'inconvenience + ...BODY CODE...)" + ;; Allow skipping the first three args. (cond ((keywordp init-value)