Small documentation fixes.

ocsigen · Nov 18, 2018 · cffe217 · cffe217
1 parent 2a50ec3
commit cffe217
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 4 deletions.
diff --git a/docs/Makefile b/docs/Makefile
@@ -15,7 +15,7 @@ MLIS=\
   $(wildcard ${SRC}/lib/*.mli) \
 	$(wildcard ${SRC}/implem/*.mli) ${SRC}/implem/tyxml.ml \
 	$(wildcard ${SRC}/tools/*.mli) \
-  ${SRC}/ppx/ppx_tyxml.mli
+  ${SRC}/ppx/tyxml_ppx.mli
 
 DOCOPT := -colorize-code -short-functors -charset utf-8
 

diff --git a/docs/indexdoc b/docs/indexdoc
@@ -24,12 +24,13 @@ Xml_sigs
 Xml_wrap
 Xml_iter
 Xml_print
+Xml_stream
 }
 
 {1 Ppx library}
 
 {!modules:
-Ppx_tyxml
+Tyxml_ppx
 }
 
 {1 Indexes}

diff --git a/lib/html_sigs.mli b/lib/html_sigs.mli
@@ -1067,7 +1067,7 @@ module type T = sig
 
   (** [import signal] converts the given XML signal into Tyxml elements.
       It can be used with HTML and SVG parsing libraries, such as Markup.
-      @raise malformed_stream if the stream is malformed.
+      @raise Xml_stream.Malformed_stream if the stream is malformed.
   *)
   val of_seq : Xml_stream.signal Seq.t -> 'a elt list_wrap
 

diff --git a/lib/svg_sigs.mli b/lib/svg_sigs.mli
@@ -969,7 +969,7 @@ module type T = sig
 
   (** [import signal] converts the given XML signal into Tyxml elements.
       It can be used with HTML and SVG parsing libraries, such as Markup.
-      @raise malformed_stream if the stream is malformed.
+      @raise Xml_stream.Malformed_stream if the stream is malformed.
   *)
   val of_seq : Xml_stream.signal Seq.t -> 'a elt list_wrap
 

diff --git a/lib/xml_stream.mli b/lib/xml_stream.mli
@@ -17,6 +17,8 @@
  * Foundation, Inc., 51 Franklin Street, Suite 500, Boston, MA 02111-1307, USA.
 *)
 
+(** Streaming IO to/from XML trees *)
+
 type name = string * string
 
 (** {2 Input} *)