;;; help-fns.el --- Complex help functions
-;; Copyright (C) 1985, 1986, 1993, 1994, 1998, 1999, 2000, 2001, 2002
+;; Copyright (C) 1985, 1986, 1993, 1994, 1998, 1999, 2000, 2001, 2002, 2003
;; Free Software Foundation, Inc.
;; Maintainer: FSF
(newline n))
;; Some people get confused by the large gap.
(newline (/ n 2))
-
+
;; Skip the [...] line (don't delete it).
(forward-line 1)
(newline (- n (/ n 2)))))
(defun help-add-fundoc-usage (doc arglist)
"Add the usage info to the docstring DOC.
If DOC already has a usage info, then just return DOC unchanged.
-The usage info is built from ARGLIST. DOC can be nil."
+The usage info is built from ARGLIST. DOC can be nil.
+ARGLIST can also be t or a string of the form \"(fun ARG1 ARG2 ...)\"."
(unless (stringp doc) (setq doc "Not documented"))
- (if (string-match "\n\n(fn\\(\\( .*\\)?)\\)\\'" doc)
+ (if (or (string-match "\n\n(fn\\(\\( .*\\)?)\\)\\'" doc) (eq arglist t))
doc
(format "%s%s%s" doc
(if (string-match "\n?\n\\'" doc)
- (if (< (- (match-end 0) (match-beginning 0)) 2) "\n")
+ (if (< (- (match-end 0) (match-beginning 0)) 2) "\n" "")
"\n\n")
- (help-make-usage 'fn arglist))))
+ (if (and (stringp arglist)
+ (string-match "\\`([^ ]+\\(.*\\))\\'" arglist))
+ (concat "(fn" (match-string 1 arglist) ")")
+ (help-make-usage 'fn arglist)))))
(defun help-function-arglist (def)
;; Handle symbols aliased to other symbols.
(princ ".")
(terpri)
(when (commandp function)
- (let* ((remapped (remap-command function))
+ (let* ((remapped (command-remapping function))
(keys (where-is-internal
- (or remapped function) overriding-local-map nil nil)))
+ (or remapped function) overriding-local-map nil nil)))
(when remapped
(princ "It is remapped to `")
(princ (symbol-name remapped))
function)))))
usage)
(car usage))
+ ((or (stringp def)
+ (vectorp def))
+ (format "\nMacro: %s" (format-kbd-macro def)))
(t "[Missing arglist. Please make a bug report.]")))
(terpri))
(let ((obsolete (and
(delete-region (1- from) from)))))
(terpri)
(when (local-variable-p variable)
- (princ (format "Local in buffer %s; " (buffer-name)))
+ (princ (format "%socal in buffer %s; "
+ (if (get variable 'permanent-local)
+ "Permanently l" "L")
+ (buffer-name)))
(if (not (default-boundp variable))
(princ "globally void")
(let ((val (default-value variable)))
(terpri))
(princ (or doc "Not documented as a variable.")))
;; Make a link to customize if this variable can be customized.
- ;; Note, it is not reliable to test only for a custom-type property
- ;; because those are only present after the var's definition
- ;; has been loaded.
- (if (or (get variable 'custom-type) ; after defcustom
- (get variable 'custom-loads) ; from loaddefs.el
- (get variable 'standard-value)) ; from cus-start.el
+ (if (custom-variable-p variable)
(let ((customize-label "customize"))
(terpri)
(terpri)