]> git.eshelyaron.com Git - emacs.git/commitdiff
Add/fix documentation for widget-apply
authorJuanma Barranquero <lekktu@gmail.com>
Wed, 16 Oct 2019 13:39:42 +0000 (15:39 +0200)
committerJuanma Barranquero <lekktu@gmail.com>
Wed, 16 Oct 2019 13:39:42 +0000 (15:39 +0200)
* doc/misc/widget.texi (Widget Properties): Document `widget-apply'.

* src/fns.c (Fwidget_apply): Document return value (used in many
places).

doc/misc/widget.texi
src/fns.c

index 6d94768644fd025af9cff3ee56176a9c1e264595..c1127a466a75e2223888dbc44318a893ff309927 100644 (file)
@@ -1446,6 +1446,12 @@ Non-@code{nil} if @var{widget} has a value (even @code{nil}) for
 property @var{property}.
 @end defun
 
+@defun widget-apply widget property &rest args
+Apply the value of @var{property} to @var{widget}, passing @var{args}
+as additional arguments to the function.  Return the result of that
+function call.
+@end defun
+
 Occasionally it can be useful to know which kind of widget you have,
 i.e., the name of the widget type you gave when the widget was created.
 
index fc1abe8b18aa408dd704c60d23cb82ae1d1c75f0..cbb6879223db65bde0f1953fb85114706e85b241 100644 (file)
--- a/src/fns.c
+++ b/src/fns.c
@@ -3093,6 +3093,7 @@ later with `widget-put'.  */)
 
 DEFUN ("widget-apply", Fwidget_apply, Swidget_apply, 2, MANY, 0,
        doc: /* Apply the value of WIDGET's PROPERTY to the widget itself.
+Return the result of applying the value of PROPERTY to WIDGET.
 ARGS are passed as extra arguments to the function.
 usage: (widget-apply WIDGET PROPERTY &rest ARGS)  */)
   (ptrdiff_t nargs, Lisp_Object *args)