mirrors/emacs
1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2025-12-15 10:30:25 -08:00
Code Issues Projects Releases Wiki Activity

(help-add-fundoc-usage): Allow arglist to be a string.

Browse source
This commit is contained in:
Stefan Monnier 2003-05-04 00:30:34 +00:00
parent 9d3153eb87
commit 95734598cd
1 changed files with 7 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

10
lisp/help-fns.el
View file

@ -175,15 +175,19 @@ DEF is the function whose usage we're looking for in DOC."
(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 nil 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) (not arglist))
doc
(format "%s%s%s" doc
(if (string-match "\n?\n\\'" doc)
(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.