Browse Source

Add doc comment for ToC

master
buttercat1791 9 months ago
parent
commit
f635d08982
  1. 7
      src/lib/components/publications/table_of_contents.svelte.ts

7
src/lib/components/publications/table_of_contents.svelte.ts

@ -11,6 +11,13 @@ export interface TocEntry { @@ -11,6 +11,13 @@ export interface TocEntry {
depth: number;
}
/**
* Maintains a table of contents (ToC) for a `SveltePublicationTree`. Since publication trees are
* conceptually infinite and lazy-loading, the ToC represents only the portion of the tree that has
* been "discovered". The ToC is updated as new nodes are resolved within the publication tree.
*
* @see SveltePublicationTree
*/
export class TableOfContents {
public addressMap: SvelteMap<string, TocEntry> = new SvelteMap();

Loading…
Cancel
Save