diff --git a/deno.json b/deno.json index ae67efd6..4f72accd 100644 --- a/deno.json +++ b/deno.json @@ -1,7 +1,6 @@ { "name": "@silverbulletmd/silverbullet", "version": "0.9.0", - "description": "Silverbullet is a Personal Knowledge Management System", "exports": { "./syscall": "./plug-api/syscall.ts", "./syscalls": "./plug-api/syscalls.ts", diff --git a/plug-api/syscalls/clientStore.ts b/plug-api/syscalls/clientStore.ts index 0c5cd84c..d3bb5b60 100644 --- a/plug-api/syscalls/clientStore.ts +++ b/plug-api/syscalls/clientStore.ts @@ -3,6 +3,7 @@ import { syscall } from "../syscall.ts"; /** * Implements a very simple (string) key value store for the client. * Generally should only be used to set some client-specific states, such as preferences. + * @module */ /** diff --git a/plug-api/syscalls/datastore.ts b/plug-api/syscalls/datastore.ts index 7caccaf5..333e12da 100644 --- a/plug-api/syscalls/datastore.ts +++ b/plug-api/syscalls/datastore.ts @@ -3,6 +3,7 @@ import type { KV, KvKey, KvQuery } from "../types.ts"; /** * Exposes a key value story with query capabilities. + * @module */ /** diff --git a/plug-api/syscalls/editor.ts b/plug-api/syscalls/editor.ts index 2b325065..b7806a5f 100644 --- a/plug-api/syscalls/editor.ts +++ b/plug-api/syscalls/editor.ts @@ -6,6 +6,7 @@ import type { FilterOption } from "@silverbulletmd/silverbullet/type/client"; /** * Exposes various editor utilities. * Important: These syscalls are only available in the client. + * @module */ /** diff --git a/plug-api/syscalls/event.ts b/plug-api/syscalls/event.ts index b2163ea8..846036b7 100644 --- a/plug-api/syscalls/event.ts +++ b/plug-api/syscalls/event.ts @@ -1,5 +1,10 @@ import { syscall } from "../syscall.ts"; +/** + * Exposes the SilverBullet event bus. + * @module + */ + /** * Triggers an event on the SilverBullet event bus. * This can be used to implement an RPC-style system too, because event handlers can return values, diff --git a/plug-api/syscalls/mq.ts b/plug-api/syscalls/mq.ts index 43f87173..46072c82 100644 --- a/plug-api/syscalls/mq.ts +++ b/plug-api/syscalls/mq.ts @@ -3,6 +3,7 @@ import type { MQStats } from "../types.ts"; /** * Implements a simple Message Queue system. + * @module */ /** diff --git a/plug-api/syscalls/space.ts b/plug-api/syscalls/space.ts index f0d6f40f..6637abe7 100644 --- a/plug-api/syscalls/space.ts +++ b/plug-api/syscalls/space.ts @@ -1,6 +1,11 @@ import { syscall } from "../syscall.ts"; import type { AttachmentMeta, FileMeta, PageMeta } from "../types.ts"; +/** + * Exposes the space with its pages, attachments and plugs. + * @module + */ + /** * Lists all pages (files ending in .md) in the space. * @param unfiltered diff --git a/plug-api/syscalls/sync.ts b/plug-api/syscalls/sync.ts index 9c9314b5..29622517 100644 --- a/plug-api/syscalls/sync.ts +++ b/plug-api/syscalls/sync.ts @@ -2,6 +2,7 @@ import { syscall } from "../syscall.ts"; /** * Syscalls that interact with the sync engine (when the client runs in Sync mode) + * @module */ /** diff --git a/plug-api/syscalls/system.ts b/plug-api/syscalls/system.ts index 70d07207..0db13a28 100644 --- a/plug-api/syscalls/system.ts +++ b/plug-api/syscalls/system.ts @@ -4,6 +4,11 @@ import type { ParseTree } from "../lib/tree.ts"; import { syscall } from "../syscall.ts"; import type { Config } from "../../type/config.ts"; +/** + * System level syscalls + * @module + */ + /** * Invoke a plug function * @param name a string representing the name of the function to invoke ("plug.functionName") diff --git a/plug-api/syscalls/yaml.ts b/plug-api/syscalls/yaml.ts index bcd2eb02..c73979e8 100644 --- a/plug-api/syscalls/yaml.ts +++ b/plug-api/syscalls/yaml.ts @@ -1,5 +1,10 @@ import { syscall } from "../syscall.ts"; +/** + * YAML operations + * @module + */ + /** * Parses a YAML string into a JavaScript object. * @param text the YAML text to parse