X-Git-Url: https://code.delx.au/gnu-emacs/blobdiff_plain/b578f267af27af50e3c091f8c9c9eee939b69978..66236b772af493888a34148662dca58561958a6f:/lisp/docref.el diff --git a/lisp/docref.el b/lisp/docref.el index 363ce6c33d..9aa6a604b2 100644 --- a/lisp/docref.el +++ b/lisp/docref.el @@ -60,17 +60,27 @@ ;;; Code: ;; User customizable variables - -(defvar docref-highlight-p t +(defgroup docref nil + "Simple cross references for Elisp documentation strings." + :prefix "docref-" + :group 'help + :group 'lisp + :group 'docs) + +(defcustom docref-highlight-p t "*If non-nil, \\(f@docref-subst) highlights cross-references. Under window system it highlights them with face defined by \\(v@docref-highlight-face), on character terminal highlighted references -look like cross-references in info mode.") +look like cross-references in info mode." + :type 'boolean + :group 'docref) -(defvar docref-highlight-face 'highlight - "*Face used to highlight cross-references (used by \\(f@docref-subst))") +(defcustom docref-highlight-face 'highlight + "*Face used to highlight cross-references (used by \\(f@docref-subst))" + :type 'face + :group 'docref) -(defvar docref-methods-alist +(defcustom docref-methods-alist '(("f" . docref-describe-function) ; reference to a function documentation ("v" . docref-describe-variable) ; reference to a variable documentation ("F" . docref-read-file) ; reference to a file contents @@ -81,10 +91,14 @@ look like cross-references in info mode.") The car of each element is a string that serves as `type' in cross-references. \(See \\(f@docref-subst)). The cdr is a function of one argument, -to be called to find this reference.") - -(defvar docref-back-label "\nback" - "Label to use by \\(f@docref-subst) for the go-back reference.") +to be called to find this reference." + :type '(repeat (cons string function)) + :group 'docref) + +(defcustom docref-back-label "\nback" + "Label to use by \\(f@docref-subst) for the go-back reference." + :type 'string + :group 'docref) (defvar docref-back-reference nil "If non-nil, this is a go-back reference to add to the current buffer.