Skip to content

Commit

Permalink
tweak jsdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
christo committed Dec 23, 2024
1 parent 801358d commit c7c558e
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
4 changes: 1 addition & 3 deletions client/src/machine/DataView.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@ import {LogicalLine} from "./api.ts";

/**
* Representation of a generic view of data, a vertical sequence of horizontal string of kv pairs.
* A generic displayable structure with a sequence of entries. Each entry is a sequence of
* string tuples. The string tuple represents a name-value pair that will be rendered with
* the name as a className and the value as the text content of a span element.
* A generic displayable structure with a sequence of {@link LogicalLine LogicalLines}.
*/
interface DataView {
getLines(): LogicalLine[];
Expand Down
3 changes: 3 additions & 0 deletions client/src/machine/api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ import {Memory} from "./Memory.ts";

/**
* Renderable output of structured text with html-friendly structure and internal text renderer.
* A sequence of string tuples that represent a name-value pair that will be rendered with
* the name as a className and the value as the text content of a span element.
*/
class Tag {

Expand Down Expand Up @@ -76,6 +78,7 @@ class LogicalLine {

/**
* Temporary transition encapsulation
*
* TODO: use an abstraction that more closely models the domain, tags carry too much responsibility
*/
private readonly tags: Tag[];
Expand Down

0 comments on commit c7c558e

Please sign in to comment.