diff options
author | Hugo Hörnquist <hugo@lysator.liu.se> | 2023-09-05 11:41:46 +0200 |
---|---|---|
committer | Hugo Hörnquist <hugo@lysator.liu.se> | 2023-09-05 11:41:46 +0200 |
commit | f653a01328be3b8be6af35c0c96867623765ca5b (patch) | |
tree | aee9a5d3abfc39270f55defd7bc1a7e47920ffc3 /doc/ref/javascript/formatters.texi | |
parent | Minor whitespace cleanup. (diff) | |
download | calp-f653a01328be3b8be6af35c0c96867623765ca5b.tar.gz calp-f653a01328be3b8be6af35c0c96867623765ca5b.tar.xz |
Move JS documentation into the JS-code.
Texinfo was a bad match for how TypeScript is structured. This also
allows generation of jsdoc pages, which can be nice.
Another large win is that this opens up for the texinfo pages to replace
the Guile heading with different subheadings, including
- external library
- internal library
- C library
- ...
Diffstat (limited to 'doc/ref/javascript/formatters.texi')
-rw-r--r-- | doc/ref/javascript/formatters.texi | 23 |
1 files changed, 0 insertions, 23 deletions
diff --git a/doc/ref/javascript/formatters.texi b/doc/ref/javascript/formatters.texi deleted file mode 100644 index a3086aa9..00000000 --- a/doc/ref/javascript/formatters.texi +++ /dev/null @@ -1,23 +0,0 @@ -@node formatters -@subsection formatters - -Formatting procedures used by some components. -@c TODO can we have a backref of every node containing @ref{formatters-proc}? - -@deftypefun void format(targetElement:HTMLElement, data:VEvent, key:string) -Checks if a specific formatter exists for the given key, and executes -it. -Defaults to 'default', and also runs that if the regular formatter throws. -@end deftypefun - -@deftypevar {Map<string, (e:HTMLElement, d:VEvent, s:any) => void>} formatters -@anchor{formatters-proc} - -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, d:VEvent, s:string) => void>} formatters -Same object as @xref{formatters-proc}. Provided for @xref{user-additions.js}. -@end deftypevr |