From b52ca1b59fe486479e6a910c507429dfc3e430ce Mon Sep 17 00:00:00 2001 From: zapisanchez Date: Fri, 24 Nov 2023 11:10:15 +0100 Subject: [PATCH] add comments --- libxml2.go | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/libxml2.go b/libxml2.go index e88ed98..e610c4b 100644 --- a/libxml2.go +++ b/libxml2.go @@ -1,3 +1,19 @@ +//go:generate go run internal/cmd/genwrapnode/genwrapnode.go -- dom/node_wrap.go + +/* +Package libxml2 is an interface to libxml2 library, providing XML and HTML parsers +with DOM interface. The inspiration is Perl5's XML::LibXML module. + +This library is still in very early stages of development. API may still change +without notice. + +For the time being, the API is being written so that thye are as close as we +can get to DOM Layer 3, but some methods will, for the time being, be punted +and aliases for simpler methods that don't necessarily check for the DOM's +correctness will be used. + +Also, the return values are still shaky -- I'm still debating how to handle error cases gracefully. +*/ package libxml2 import (