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 /static/ts/components/vevent-description.ts | |
| 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 'static/ts/components/vevent-description.ts')
| -rw-r--r-- | static/ts/components/vevent-description.ts | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/static/ts/components/vevent-description.ts b/static/ts/components/vevent-description.ts index b44185e7..bf62c10d 100644 --- a/static/ts/components/vevent-description.ts +++ b/static/ts/components/vevent-description.ts @@ -1,3 +1,19 @@ +/** + * `<vevent-description />` + +A text representation of a VEvent. Used as the summary tab of our +popup windows, and in the sidebar. + +When redrawn, it looks for an HTML-tag inside its template having the +attribute `data-property` matching the properties name. If one is +found, it looks in the `formatters` table +({@link formatters}), for a field matching the property value, and +defaults to the key `default`. + * + * @category Web Components + * @mergeTarget components + * @module + */ export { ComponentDescription } import { VEvent } from '../vevent' |