📝 Add documentation comments on function

Author: lambdalisue

denops_std/function/README.md

@@ -1,38 +1,7 @@
-# function
-
-`function`, `function/vim`, and `function/nvim` are modules to provide functions
-of Vim and Neovim native functions.
-
-- [API documentation](https://doc.deno.land/https/deno.land/x/denops_std/function/mod.ts)
-- [API documentation (Vim)](https://doc.deno.land/https/deno.land/x/denops_std/function/vim/mod.ts)
-- [API documentation (Neovim)](https://doc.deno.land/https/deno.land/x/denops_std/function/nvim/mod.ts)
-
 Most of codes are automatically generated by
 [`gen-function.ts`](../../scripts/gen-function/gen-function.ts) from `eval.txt`
 in minimal supported Vim and Neovim versions.
 
-## Example
-
-```typescript
-import { Denops } from "../mod.ts";
-import * as fn from "../function/mod.ts";
-import * as vimFn from "../function/vim/mod.ts";
-import * as nvimFn from "../function/nvim/mod.ts";
-
-export async function main(denops: Denops): Promise<void> {
-  // fn holds functions exists in both Vim and Neovim
-  console.log(fn.or(denops, 0, 1));
-
-  // vimFn holds functions exists only in Vim
-  console.log(vimFn.balloon_gettext(denops));
-
-  // nvimFn holds functions exists only in Neovim
-  console.log(nvimFn.api_info(denops));
-}
-```
-
-## How to add functions manually
-
 To add functions manually, create or modify corresponding module under
 `function`, `function/vim`, or `function/nvim` module then make sure that module
 is listed in `_manual.ts` uneder corresponding module. After that, execute

denops_std/function/mod.ts

@@ -1,3 +1,20 @@
+/**
+ * A module to provide functions of Vim and Neovim native functions.
+ *
+ * ```typescript
+ * import { Denops } from "../mod.ts";
+ * import * as fn from "../function/mod.ts";
+ *
+ * export async function main(denops: Denops): Promise<void> {
+ *   // fn holds functions exists in both Vim and Neovim
+ *   console.log(fn.or(denops, 0, 1));
+ * }
+ * ```
+ *
+ * See [`vim/mod.ts`](./vim/mod.ts) or [`nvim/mod.ts`](nvim/mod.ts) if you need Vim or Neovim specific functions.
+ *
+ * @module
+ */
 // NOTE:
 // Do NOT add modules manually to this file.
 // Add modules to `_manual.ts` instead for manually written modules.

denops_std/function/nvim/mod.ts

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

denops_std/function/vim/mod.ts

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