Skip to content

Commit fbf782f

Browse files
committed
jsdoc: document HtmlQueryResultsRenderer class
1 parent 1f192b0 commit fbf782f

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

src/Renderer/HtmlQueryResultsRenderer.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,13 @@ import type { QueryRendererParameters } from './QueryResultsRenderer';
1212
import { QueryResultsRendererBase, type QueryResultsRendererGetters } from './QueryResultsRendererBase';
1313
import { TaskLineRenderer, type TextRenderer, createAndAppendElement } from './TaskLineRenderer';
1414

15+
/**
16+
* HTML-specific implementation of {@link QueryResultsRendererBase} abstract class.
17+
*
18+
* @example
19+
* this.htmlRenderer.content = content;
20+
* await this.htmlRenderer.renderQuery(state, tasks);
21+
*/
1522
export class HtmlQueryResultsRenderer extends QueryResultsRendererBase {
1623
// Renders the description in TaskLineRenderer:
1724
protected readonly textRenderer;

0 commit comments

Comments
 (0)