@@ -1,5 +1,7 @@
11{-# LANGUAGE RecordWildCards #-}
22
3+-- | A module for first-approximation parsing of XML.
4+-- Note that entities, e.g. @&@, are not expanded.
35module Text.XML.Hexml(
46 Document, Node, Attribute(..),
57 documentParse, documentRender, documentNode,
@@ -56,6 +58,7 @@ foreign import ccall node_attributes :: Ptr CDocument -> Ptr CNode -> Ptr CInt -
5658foreign import ccall node_childBy :: Ptr CDocument -> Ptr CNode -> Ptr CNode -> CString -> CInt -> IO (Ptr CNode)
5759foreign import ccall node_attributeBy :: Ptr CDocument -> Ptr CNode -> CString -> CInt -> IO (Ptr CAttr)
5860
61+-- | An XML document, created by 'documentParse'.
5962data Document = Document BS.ByteString (ForeignPtr CDocument)
6063
6164data Node = Node BS.ByteString (ForeignPtr CDocument) (Ptr CNode)