Skip to content

Commit 88503ef

Browse files
authored
fix(xml): update doc
1 parent cbef504 commit 88503ef

File tree

2 files changed

+10
-4
lines changed

2 files changed

+10
-4
lines changed

xml/parse.ts

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
/**
2+
* Parse a XML string into an object.
3+
* @module
4+
*/
5+
16
// Imports
27
import { initSync, JsReader, source, Token, tokenize } from "./wasm_xml_parser/wasm_xml_parser.js"
38
import type { Nullable, ReaderSync, xml_document, xml_node, xml_text } from "./_types.ts"
@@ -109,8 +114,6 @@ export type options = {
109114
* using file = await Deno.open(fromFileUrl(import.meta.resolve("./bench/assets/small.xml")))
110115
* console.log(parse(file))
111116
* ```
112-
*
113-
* @module
114117
*/
115118
export function parse(content: string | ReaderSync, options?: options): xml_document {
116119
const xml = xml_node("~xml") as xml_document

xml/stringify.ts

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
/**
2+
* Stringify an XML document object into a XML string.
3+
* @module
4+
*/
5+
16
// Imports
27
import type { Nullable, stringifyable, xml_document, xml_node, xml_text } from "./_types.ts"
38
export type { Nullable, stringifyable, xml_document, xml_node, xml_text }
@@ -60,8 +65,6 @@ const internal = Symbol("internal")
6065
* }
6166
* }))
6267
* ```
63-
*
64-
* @module
6568
*/
6669
export function stringify(document: stringifyable, options?: options): string {
6770
options ??= {}

0 commit comments

Comments
 (0)