aboutsummaryrefslogtreecommitdiff
path: root/doc/ref/javascript/formatters.texi
diff options
context:
space:
mode:
Diffstat (limited to 'doc/ref/javascript/formatters.texi')
-rw-r--r--doc/ref/javascript/formatters.texi9
1 files changed, 5 insertions, 4 deletions
diff --git a/doc/ref/javascript/formatters.texi b/doc/ref/javascript/formatters.texi
index 16a988c4..71394b39 100644
--- a/doc/ref/javascript/formatters.texi
+++ b/doc/ref/javascript/formatters.texi
@@ -4,13 +4,14 @@
Formatting procedures used by some components.
@c TODO can we have a backref of every node containing @ref{formatters-proc}?
-@deftypevar {Map<string, (e:HTMLElement, s:any) => void>} formatters
+@deftypevar {Map<string, (e:HTMLElement, d:VEvent, s:any) => void>} formatters
@anchor{formatters-proc}
-Each procedure takes two arguments. The HTML-element which contents
-should be replaced, along with the target value, as returned by @ref{VEvent.getProperty}.
+Each procedure takes three arguments. The HTML-element which contents
+should be replaced, the VEvent containing all data, and the target
+value, as returned by @ref{VEvent.getProperty}.
@end deftypevar
-@deftypevr {Window Value} {Map<string, (e:HTMLElement, s:string) => void>} formatters
+@deftypevr {Window Value} {Map<string, (e:HTMLElement, d:VEvent, s:string) => void>} formatters
Same object as @xref{formatters-proc}. Provided for @xref{user-additions.js}.
@end deftypevr