From 2cc25f2635b590694dd81363a982873b5e184c30 Mon Sep 17 00:00:00 2001 From: Clombrong Date: Fri, 20 Jun 2025 21:50:14 +0200 Subject: docs(xml): document the tree function --- lib/xml.ml | 2 ++ 1 file changed, 2 insertions(+) (limited to 'lib/xml.ml') diff --git a/lib/xml.ml b/lib/xml.ml index c73bad6..1b286bb 100644 --- a/lib/xml.ml +++ b/lib/xml.ml @@ -8,6 +8,8 @@ type element = { } let tree s : element option = + (** [tree s] is an [element option] representing the XML element inside of stream [s], + if [s] is a complete element from start to end. *) let element (namespace, name) attributes children = Either.Left { namespace; -- cgit v1.2.3