From 595d812ea39b18faa35c63bbd001de4a0b495aea Mon Sep 17 00:00:00 2001
From: Yoshiya Hinosawa <stibium121@gmail.com>
Date: Wed, 29 May 2024 18:15:48 +0900
Subject: [PATCH] docs(html): improve API docs (#4878)

---
 _tools/check_docs.ts |  1 +
 html/entities.ts     | 11 +++++++++--
 2 files changed, 10 insertions(+), 2 deletions(-)

diff --git a/_tools/check_docs.ts b/_tools/check_docs.ts
index 30b95f447..9b96cbf84 100644
--- a/_tools/check_docs.ts
+++ b/_tools/check_docs.ts
@@ -39,6 +39,7 @@ const ENTRY_POINTS = [
   "../fmt/duration.ts",
   "../fmt/printf.ts",
   "../front_matter/mod.ts",
+  "../html/mod.ts",
   "../http/mod.ts",
   "../internal/mod.ts",
   "../jsonc/mod.ts",
diff --git a/html/entities.ts b/html/entities.ts
index 04800bf26..77d17c659 100644
--- a/html/entities.ts
+++ b/html/entities.ts
@@ -25,7 +25,7 @@ const rawRe = new RegExp(`[${[...rawToEntity.keys()].join("")}]`, "g");
 /**
  * Escapes text for safe interpolation into HTML text content and quoted attributes.
  *
- * @example
+ * @example Usage
  * ```ts
  * import { escape } from "@std/html/entities";
  *
@@ -35,6 +35,9 @@ const rawRe = new RegExp(`[${[...rawToEntity.keys()].join("")}]`, "g");
  * // even if named HTML entities exist for them.
  * escape("þð"); // "þð"
  * ```
+ *
+ * @param str The string to escape.
+ * @returns The escaped string.
  */
 export function escape(str: string): string {
   return str.replaceAll(rawRe, (m) => rawToEntity.get(m)!);
@@ -57,7 +60,7 @@ const entityListRegexCache = new WeakMap<EntityList, RegExp>();
 /**
  * Unescapes HTML entities in text.
  *
- * @example
+ * @example Usage
  * ```ts
  * import { unescape } from "@std/html/entities";
  *
@@ -70,6 +73,10 @@ const entityListRegexCache = new WeakMap<EntityList, RegExp>();
  *
  * unescape("&thorn;&eth;", { entityList }); // "þð"
  * ```
+ *
+ * @param str The string to unescape.
+ * @param options Options for unescaping.
+ * @returns The unescaped string.
  */
 export function unescape(
   str: string,