docs(toml): lint @std/toml docs

_tools/check_docs.ts

@@ -33,6 +33,7 @@ const ENTRY_POINTS = [
   "../internal/mod.ts",
   "../jsonc/mod.ts",
   "../media_types/mod.ts",
+  "../toml/mod.ts",
   "../ulid/mod.ts",
   "../webgpu/mod.ts",
   "../http/mod.ts",

toml/parse.ts

@@ -5,7 +5,21 @@ import { ParserFactory, Toml } from "./_parser.ts";
 
 /**
  * Parse parses TOML string into an object.
- * @param tomlString
+ *
+ * @example Decode TOML string
+ * ```ts
+ * import { parse } from "./mod.ts";
+ * const tomlString = `title = "TOML Example"
+ * [owner]
+ * name = "Alice"
+ * bio = "Alice is a programmer."`;
+ *
+ * const obj = parse(tomlString);
+ * console.log(obj);
+ * // { title: "TOML Example", owner: { name: "Alice", bio: "Alice is a programmer." } }
+ * ```
+ * @param tomlString TOML string to be parsed.
+ * @returns The parsed JS object.
  */
 export const parse: (tomlString: string) => Record<string, unknown> =
   ParserFactory(Toml);

toml/stringify.ts

@@ -260,9 +260,25 @@ class Dumper {
 
 /**
  * Stringify dumps source object into TOML string and returns it.
- * @param srcObj
+ *
+ * @example Stringify an object
+ * ```ts
+ * import { stringify } from "@std/toml";
+ *
+ * const obj = {
+ *  title: "TOML Example",
+ *  owner: {
+ *    name: "Bob",
+ *    bio: "Bob is a cool guy",
+ *  }
+ * };
+ * const tomlString = stringify(obj);
+ * console.log(tomlString);
+ * ```
+ * @param srcObj source object
  * @param [fmtOptions] format options
  * @param [fmtOptions.keyAlignment] whether to align keys
+ * @returns TOML string
  */
 export function stringify(
   srcObj: Record<string, unknown>,