mirrors/emacs
1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2026-01-04 11:00:45 -08:00
Code Issues Projects Releases Wiki Activity

(eldoc-get-fnsym-args-string): Doc fix.

Browse source 
(eldoc-highlight-function-argument): Add a doc string.  Tweak previous
change: no need for INDEX to be optional, just need to handle nil.
This commit is contained in:
Glenn Morris 2007-08-19 03:05:35 +00:00
parent 1283140e1e
commit ae0195c043
2 changed files with 17 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

19
lisp/emacs-lisp/eldoc.el
View file

@ -264,11 +264,15 @@ Emacs Lisp mode) that support Eldoc.")
;; so we need to be careful that errors aren't ignored.
(error (message "eldoc error: %s" err))))
;; FIXME improve doc-string.
(defun eldoc-get-fnsym-args-string (sym &optional argument-index)
(defun eldoc-get-fnsym-args-string (sym &optional index)
"Return a string containing the parameter list of the function SYM.
If SYM is a subr and no arglist is obtainable from the docstring
or elsewhere, return a 1-line docstring."
or elsewhere, return a 1-line docstring. Calls the functions
`eldoc-function-argstring-format' and
`eldoc-highlight-function-argument' to format the result. The
former calls `eldoc-argument-case'; the latter gives the
function name `font-lock-function-name-face', and optionally
highlights argument number INDEX. "
(let (args doc)
(cond ((not (and sym (symbolp sym) (fboundp sym))))
((and (eq sym (aref eldoc-last-data 0))
@ -292,12 +296,11 @@ or elsewhere, return a 1-line docstring."
;; Change case, highlight, truncate.
(if args
(eldoc-highlight-function-argument
;; FIXME apply word by word, ignore &optional, &rest.
sym (eldoc-function-argstring-format args) argument-index))))
sym (eldoc-function-argstring-format args) index))))
;; Highlight argument INDEX in ARGS list for SYM.
;; In the absence of INDEX, just call eldoc-docstring-format-sym-doc.
(defun eldoc-highlight-function-argument (sym args &optional index)
(defun eldoc-highlight-function-argument (sym args index)
"Highlight argument INDEX in ARGS list for function SYM.
In the absence of INDEX, just call `eldoc-docstring-format-sym-doc'."
(let ((start nil)
(end 0)
(argument-face 'bold))