on master help sign in
Some module doc comments
3eb8ee0Neil Mitchell
src/Text/XML/Hexml.hs+3
@@ -1,5 +1,7 @@
1{-# LANGUAGE RecordWildCards #-}
1{-# LANGUAGE RecordWildCards #-}
2
2
3+-- | A module for first-approximation parsing of XML.
4+-- Note that entities, e.g. @&@, are not expanded.
3module Text.XML.Hexml(
5module Text.XML.Hexml(
4 Document, Node, Attribute(..),
6 Document, Node, Attribute(..),
5 documentParse, documentRender, documentNode,
7 documentParse, documentRender, documentNode,
@@ -56,6 +58,7 @@ foreign import ccall node_attributes :: Ptr CDocument -> Ptr CNode -> Ptr CInt -
56foreign import ccall node_childBy :: Ptr CDocument -> Ptr CNode -> Ptr CNode -> CString -> CInt -> IO (Ptr CNode)
58foreign import ccall node_childBy :: Ptr CDocument -> Ptr CNode -> Ptr CNode -> CString -> CInt -> IO (Ptr CNode)
57foreign import ccall node_attributeBy :: Ptr CDocument -> Ptr CNode -> CString -> CInt -> IO (Ptr CAttr)
59foreign import ccall node_attributeBy :: Ptr CDocument -> Ptr CNode -> CString -> CInt -> IO (Ptr CAttr)
58
60
61+-- | An XML document, created by 'documentParse'.
59data Document = Document BS.ByteString (ForeignPtr CDocument)
62data Document = Document BS.ByteString (ForeignPtr CDocument)
60
63
61data Node = Node BS.ByteString (ForeignPtr CDocument) (Ptr CNode)
64data Node = Node BS.ByteString (ForeignPtr CDocument) (Ptr CNode)