aboutsummaryrefslogtreecommitdiff
path: root/lib/xml_parser.mli
diff options
context:
space:
mode:
authorRegis-Gianas2014-11-04 12:09:07 +0100
committerRegis-Gianas2014-11-04 22:51:36 +0100
commitd3b4b78faced5dae3c4b8f2b05dc40375a7a6d91 (patch)
tree3943487bcb7c6d50d3b3b1f0824ae318e1ea05fa /lib/xml_parser.mli
parent99eb8aa251328a42324455460ecc20aa0cbae046 (diff)
lib/Xml_parser.parse: Publish and document new interface.
Diffstat (limited to 'lib/xml_parser.mli')
-rw-r--r--lib/xml_parser.mli11
1 files changed, 7 insertions, 4 deletions
diff --git a/lib/xml_parser.mli b/lib/xml_parser.mli
index 74a7693ac8..cefb4af897 100644
--- a/lib/xml_parser.mli
+++ b/lib/xml_parser.mli
@@ -57,7 +57,7 @@ type error_msg =
| AttributeValueExpected
| EndOfTagExpected of string
| EOFExpected
- | Empty
+ | Empty
type error = error_msg * error_pos
@@ -69,7 +69,7 @@ exception File_not_found of string
val error : error -> string
(** Get the Xml error message as a string. *)
-val error_msg : error_msg -> string
+val error_msg : error_msg -> string
(** Get the line the error occured at. *)
val line : error_pos -> int
@@ -99,5 +99,8 @@ val make : source -> t
val check_eof : t -> bool -> unit
(** Once the parser is configurated, you can run the parser on a any kind
- of xml document source to parse its contents into an Xml data structure. *)
-val parse : t -> xml
+ of xml document source to parse its contents into an Xml data structure.
+
+ When [do_not_canonicalize] is set, the XML document is given as
+ is, without trying to remove blank PCDATA elements. *)
+val parse : ?do_not_canonicalize:bool -> t -> xml