📝 Add documentation comments on variable

Author: lambdalisue

denops_std/variable/README.md

@@ -2,7 +2,23 @@ import type { Denops } from "https://deno.land/x/denops_core@v3.4.1/mod.ts";
 import { Getter, Remover, Setter } from "./types.ts";
 
 /**
- * Environment variables
+ * Environment variables (`environment` or `e`)
+ *
+ * ```typescript
+ * import { Denops } from "../mod.ts";
+ * import { environment } from "../variable/mod.ts";
+ *
+ * export async function main(denops: Denops): Promise<void> {
+ *   // Set environment variable
+ *   await environment.set(denops, "DENOPS_HELLO", "world");
+ *
+ *   // Get environment variable
+ *   console.log(await environment.get(denops, "DENOPS_HELLO"));
+ *
+ *   // Remove environment variable
+ *   await environment.remove(denops, "DENOPS_HELLO");
+ * }
+ * ```
  */
 export const environment: Getter & Setter & Remover = {
   /**

denops_std/variable/environment.ts

@@ -1,3 +1,8 @@
+/**
+ * A module to provide helper accessor functions to variables
+ *
+ * @module
+ */
 export * from "./variable.ts";
 export * from "./environment.ts";
 export * from "./register.ts";

denops_std/variable/mod.ts

@@ -37,7 +37,25 @@ async function removeOption(
 }
 
 /**
- * Options
+ * Options (`options` or `o`)
+ *
+ * ```typescript
+ * import { Denops } from "../mod.ts";
+ * import { options } from "../variable/mod.ts";
+ *
+ * export async function main(denops: Denops): Promise<void> {
+ *   // Set option
+ *   await options.set(denops, "filetype", "world");
+ *
+ *   // Get option
+ *   console.log(await options.get(denops, "filetype"));
+ *
+ *   // Reset option
+ *   await options.remove(denops, "filetype");
+ * }
+ * ```
+ *
+ * Note that `options.get()` returns `defaultValue` when the option is falsy.
  */
 export const options: Getter & Setter & Remover = {
   /**
@@ -72,7 +90,25 @@ export const options: Getter & Setter & Remover = {
 export const o = options;
 
 /**
- * Local options
+ * Local options (`localOptions` or `lo`)
+ *
+ * ```typescript
+ * import { Denops } from "../mod.ts";
+ * import { localOptions } from "../variable/mod.ts";
+ *
+ * export async function main(denops: Denops): Promise<void> {
+ *   // Set option
+ *   await localOptions.set(denops, "filetype", "world");
+ *
+ *   // Get option
+ *   console.log(await localOptions.get(denops, "filetype"));
+ *
+ *   // Reset option
+ *   await localOptions.remove(denops, "filetype");
+ * }
+ * ```
+ *
+ * Note that `localOptions.get()` returns `defaultValue` when the option is falsy.
  */
 export const localOptions: Getter & Setter & Remover = {
   /**
@@ -107,7 +143,25 @@ export const localOptions: Getter & Setter & Remover = {
 export const lo = localOptions;
 
 /**
- * Global options
+ * Global options (`globalOptions` or `go`)
+ *
+ * ```typescript
+ * import { Denops } from "../mod.ts";
+ * import { globalOptions } from "../variable/mod.ts";
+ *
+ * export async function main(denops: Denops): Promise<void> {
+ *   // Set option
+ *   await globalOptions.set(denops, "filetype", "world");
+ *
+ *   // Get option
+ *   console.log(await globalOptions.get(denops, "filetype"));
+ *
+ *   // Reset option
+ *   await globalOptions.remove(denops, "filetype");
+ * }
+ * ```
+ *
+ * Note that `globalOption.get()` returns `defaultValue` when the option is falsy.
  */
 export const globalOptions: Getter & Setter & Remover = {
   /**

denops_std/variable/option.ts

@@ -2,7 +2,22 @@ import type { Denops } from "https://deno.land/x/denops_core@v3.4.1/mod.ts";
 import { Getter, Setter } from "./types.ts";
 
 /**
- * Register
+ * Register (`register` or `r`)
+ *
+ * ```typescript
+ * import { Denops } from "../mod.ts";
+ * import { register } from "../variable/mod.ts";
+ *
+ * export async function main(denops: Denops): Promise<void> {
+ *   // Set register
+ *   await register.set(denops, "a", "world");
+ *
+ *   // Get register
+ *   console.log(await register.get(denops, "a"));
+ * }
+ * ```
+ *
+ * Note that `register.get()` returns `defaultValue` when the register is falsy.
  */
 export const register: Getter & Setter = {
   /**