comparison lisp/help-fns.el @ 50799:80f5ff945c90

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

50798:2d72cdb7e9f8

	  (substring doc 0 (match-beginning 0)))))

(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."
  (unless (stringp doc) (setq doc "Not documented"))
  (if (string-match "\n\n(fn\\(\\( .*\\)?)\\)\\'" doc)
      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))))

(defun help-function-arglist (def)
  ;; Handle symbols aliased to other symbols.
  (if (and (symbolp def) (fboundp def)) (setq def (indirect-function def)))
  ;; If definition is a macro, find the function inside it.

50799:80f5ff945c90

	  (substring doc 0 (match-beginning 0)))))

(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.
ARGLIST can also be nil or a string of the form \"(fun ARG1 ARG2 ...)\"."
  (unless (stringp doc) (setq doc "Not documented"))
  (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")
	    (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.
  (if (and (symbolp def) (fboundp def)) (setq def (indirect-function def)))
  ;; If definition is a macro, find the function inside it.