aboutsummaryrefslogtreecommitdiff
path: root/lib/xml.ml
diff options
context:
space:
mode:
authorClombrong <cromblong@egregore.fun>2025-06-20 21:50:14 +0200
committerClombrong <cromblong@egregore.fun>2025-06-20 21:50:14 +0200
commit2cc25f2635b590694dd81363a982873b5e184c30 (patch)
tree550203601c8dd3f1dd4d0493724aac8e931cac59 /lib/xml.ml
parent4f9879206cd6351f7193e783460127418b4083de (diff)
docs(xml): document the tree function
Diffstat (limited to 'lib/xml.ml')
-rw-r--r--lib/xml.ml2
1 files changed, 2 insertions, 0 deletions
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;