📝 Add documentation comments on options

Author: lambdalisue

denops_std/option/README.md

@@ -1,59 +1,7 @@
-# option
-
-`option`, `option/vim`, and `option/nvim` are modules to provide accessors of
-Vim and Neovim native options.
-
-- [API documentation](https://doc.deno.land/https/deno.land/x/denops_std/option/mod.ts)
-- [API documentation (Vim)](https://doc.deno.land/https/deno.land/x/denops_std/option/vim/mod.ts)
-- [API documentation (Neovim)](https://doc.deno.land/https/deno.land/x/denops_std/option/nvim/mod.ts)
-
 Most of codes are automatically generated by
 [`gen-option.ts`](../../scripts/gen-option/gen-option.ts) from `options.txt` in
 minimal supported Vim and Neovim versions.
 
-## Example
-
-```typescript
-import { Denops } from "../mod.ts";
-import * as op from "../option/mod.ts";
-import * as vimOp from "../option/vim/mod.ts";
-import * as nvimOp from "../option/nvim/mod.ts";
-
-export async function main(denops: Denops): Promise<void> {
-  // Get value of the option.
-  // `get` is available on any options
-  // `getGlobal` is available on only global options
-  // `getLocal` is available on only local options
-  console.log(await op.autoread.get(denops));
-  console.log(await op.autoread.getGlobal(denops));
-  console.log(await op.autoread.getLocal(denops));
-
-  // Set value of the option.
-  // `set` is available on any options
-  // `setGlobal` is available on only global options
-  // `setLocal` is available on only local options
-  await op.autoread.set(denops, true);
-  await op.autoread.setGlobal(denops, true);
-  await op.autoread.setLocal(denops, true);
-
-  // Reset the option.
-  // `reset` is available on any options
-  // `resetGlobal` is available on only global options
-  // `resetLocal` is available on only local options
-  await op.autoread.reset(denops);
-  await op.autoread.resetGlobal(denops);
-  await op.autoread.resetLocal(denops);
-
-  // vimOp has options only exist in Vim
-  console.log(await vimOp.compatible.get(denops));
-
-  // nvimOp has options only exist in Neovim
-  console.log(await nvimOp.shada.get(denops));
-}
-```
-
-## How to add options manually
-
 To add options manually, create or modify corresponding module under `option`,
 `option/vim`, or `option/nvim` module then make sure that module is listed in
 `_manual.ts` under corresponding module. After that, execute `make gen` on the

denops_std/option/mod.ts

@@ -1,3 +1,41 @@
+/**
+ * A module to provide accessors of Vim and Neovim native options.
+ *
+ * ```typescript
+ * import { Denops } from "../mod.ts";
+ * import * as op from "../option/mod.ts";
+ *
+ * export async function main(denops: Denops): Promise<void> {
+ *   // Get value of the option.
+ *   // `get` is available on any options
+ *   // `getGlobal` is available on only global options
+ *   // `getLocal` is available on only local options
+ *   console.log(await op.autoread.get(denops));
+ *   console.log(await op.autoread.getGlobal(denops));
+ *   console.log(await op.autoread.getLocal(denops));
+ *
+ *   // Set value of the option.
+ *   // `set` is available on any options
+ *   // `setGlobal` is available on only global options
+ *   // `setLocal` is available on only local options
+ *   await op.autoread.set(denops, true);
+ *   await op.autoread.setGlobal(denops, true);
+ *   await op.autoread.setLocal(denops, true);
+ *
+ *   // Reset the option.
+ *   // `reset` is available on any options
+ *   // `resetGlobal` is available on only global options
+ *   // `resetLocal` is available on only local options
+ *   await op.autoread.reset(denops);
+ *   await op.autoread.resetGlobal(denops);
+ *   await op.autoread.resetLocal(denops);
+ * }
+ * ```
+ *
+ * See [`vim/mod.ts`](./vim/mod.ts) or [`nvim/mod.ts`](nvim/mod.ts) if you need Vim or Neovim specific options.
+ *
+ * @module
+ */
 // NOTE:
 // Do NOT add modules manually to this file.
 // Add modules to `_manual.ts` instead for manually written modules.

denops_std/option/nvim/mod.ts

@@ -1,3 +1,18 @@
+/**
+ * A module to provide accessors of Neovim native options.
+ *
+ * ```typescript
+ * import { Denops } from "../../mod.ts";
+ * import * as nvimOp from "../../option/nvim/mod.ts";
+ *
+ * export async function main(denops: Denops): Promise<void> {
+ *   // nvimOp has options only exist in Neovim
+ *   console.log(await nvimOp.shada.get(denops));
+ * }
+ * ```
+ *
+ * @module
+ */
 // NOTE:
 // Do NOT add modules manually to this file.
 // Add modules to `_manual.ts` instead for manually written modules.

denops_std/option/vim/mod.ts

@@ -1,3 +1,18 @@
+/**
+ * A module to provide accessors of Vim native options.
+ *
+ * ```typescript
+ * import { Denops } from "../../mod.ts";
+ * import * as vimOp from "../../option/vim/mod.ts";
+ *
+ * export async function main(denops: Denops): Promise<void> {
+ *   // vimOp has options only exist in Vim
+ *   console.log(await vimOp.compatible.get(denops));
+ * }
+ * ```
+ *
+ * @module
+ */
 // NOTE:
 // Do NOT add modules manually to this file.
 // Add modules to `_manual.ts` instead for manually written modules.