From bb50e5c5f7b0526add1fbb21777b0db3a095f19c Mon Sep 17 00:00:00 2001 From: Tom Faulhaber Date: Mon, 6 Aug 2012 13:52:12 -0700 Subject: [PATCH] Autodoc commit for master/05431000 --- api-index.html | 12 ++-- index-0.0.6.clj => index-0.0.7.clj | 109 +++++++++++++++++++++-------- index.html | 92 ++++++++++++++++++++---- 3 files changed, 166 insertions(+), 47 deletions(-) rename index-0.0.6.clj => index-0.0.7.clj (58%) diff --git a/api-index.html b/api-index.html index 67a33de..7f974fd 100644 --- a/api-index.html +++ b/api-index.html @@ -1,7 +1,7 @@ - Index - Lazy XML parsing 0.0.6 API documentation + Index - Lazy XML parsing 0.0.7 API documentation @@ -25,7 +25,7 @@

data.xml API
- Lazy XML parsing 0.0.6 API
+ Lazy XML parsing 0.0.7 API
  • Overview
  • API Index
    • @@ -41,7 +41,7 @@

    data.xml API
    -

    Index of Public Functions and Variables - Lazy XML parsing 0.0.6 (in development)

    +

    Index of Public Functions and Variables - Lazy XML parsing 0.0.7 (in development)

    This page has an alphabetical index of all the documented functions and variables in Lazy XML parsing. @@ -70,7 +70,9 @@

    data.xml API

    A

    -
+ as-elements                  function      clojure.data.xml   Return a seq of elements represented by an express...
+ AsElements                   protocol      clojure.data.xml   
+

    B

    @@ -175,6 +177,8 @@

    R

    S

      seq-tree                     function      clojure.data.xml   Takes a seq of events that logically represents a ...
+ sexp-as-element              function      clojure.data.xml   Convert a single sexp into an Element.
+ sexps-as-fragment            function      clojure.data.xml   Convert a compact prxml/hiccup-style data structur...
  source-seq                   function      clojure.data.xml   Parses the XML InputSource source using a pull-par...
    diff --git a/index-0.0.6.clj b/index-0.0.7.clj similarity index 58% rename from index-0.0.6.clj rename to index-0.0.7.clj index 7c2987d..9aff0e5 100644 --- a/index-0.0.6.clj +++ b/index-0.0.7.clj @@ -1,6 +1,6 @@ {:namespaces ({:source-url - "https://github.com/clojure/data.xml/blob/680dc2ba7a5dab8d95eae42f6e9fd8df49902855/src/main/clojure/clojure/data/xml.clj", + "https://github.com/clojure/data.xml/blob/205a9df7ea77679b4d4a253a68775859fb13a1a1/src/main/clojure/clojure/data/xml.clj", :wiki-url "http://clojure.github.com/data.xml/clojure.data.xml-api.html", :name "clojure.data.xml", @@ -12,126 +12,153 @@ :name "emit", :namespace "clojure.data.xml", :source-url - "https://github.com/clojure/data.xml/blob/680dc2ba7a5dab8d95eae42f6e9fd8df49902855/src/main/clojure/clojure/data/xml.clj#L264", + "https://github.com/clojure/data.xml/blob/205a9df7ea77679b4d4a253a68775859fb13a1a1/src/main/clojure/clojure/data/xml.clj#L323", :raw-source-url - "https://github.com/clojure/data.xml/raw/680dc2ba7a5dab8d95eae42f6e9fd8df49902855/src/main/clojure/clojure/data/xml.clj", + "https://github.com/clojure/data.xml/raw/205a9df7ea77679b4d4a253a68775859fb13a1a1/src/main/clojure/clojure/data/xml.clj", :wiki-url "http://clojure.github.com/data.xml//clojure.data.xml-api.html#clojure.data.xml/emit", :doc "Prints the given Element tree as XML text to stream.\nOptions:\n :encoding Character encoding to use", :var-type "function", - :line 264, + :line 323, :file "src/main/clojure/clojure/data/xml.clj"} {:arglists ([e]), :name "emit-str", :namespace "clojure.data.xml", :source-url - "https://github.com/clojure/data.xml/blob/680dc2ba7a5dab8d95eae42f6e9fd8df49902855/src/main/clojure/clojure/data/xml.clj#L281", + "https://github.com/clojure/data.xml/blob/205a9df7ea77679b4d4a253a68775859fb13a1a1/src/main/clojure/clojure/data/xml.clj#L340", :raw-source-url - "https://github.com/clojure/data.xml/raw/680dc2ba7a5dab8d95eae42f6e9fd8df49902855/src/main/clojure/clojure/data/xml.clj", + "https://github.com/clojure/data.xml/raw/205a9df7ea77679b4d4a253a68775859fb13a1a1/src/main/clojure/clojure/data/xml.clj", :wiki-url "http://clojure.github.com/data.xml//clojure.data.xml-api.html#clojure.data.xml/emit-str", :doc "Emits the Element to String and returns it", :var-type "function", - :line 281, + :line 340, :file "src/main/clojure/clojure/data/xml.clj"} {:arglists ([events]), :name "event-tree", :namespace "clojure.data.xml", :source-url - "https://github.com/clojure/data.xml/blob/680dc2ba7a5dab8d95eae42f6e9fd8df49902855/src/main/clojure/clojure/data/xml.clj#L158", + "https://github.com/clojure/data.xml/blob/205a9df7ea77679b4d4a253a68775859fb13a1a1/src/main/clojure/clojure/data/xml.clj#L157", :raw-source-url - "https://github.com/clojure/data.xml/raw/680dc2ba7a5dab8d95eae42f6e9fd8df49902855/src/main/clojure/clojure/data/xml.clj", + "https://github.com/clojure/data.xml/raw/205a9df7ea77679b4d4a253a68775859fb13a1a1/src/main/clojure/clojure/data/xml.clj", :wiki-url "http://clojure.github.com/data.xml//clojure.data.xml-api.html#clojure.data.xml/event-tree", :doc "Returns a lazy tree of Element objects for the given seq of Event\nobjects. See source-seq and parse.", :var-type "function", - :line 158, + :line 157, :file "src/main/clojure/clojure/data/xml.clj"} {:arglists ([e stream & {:as opts}]), :name "indent", :namespace "clojure.data.xml", :source-url - "https://github.com/clojure/data.xml/blob/680dc2ba7a5dab8d95eae42f6e9fd8df49902855/src/main/clojure/clojure/data/xml.clj#L294", + "https://github.com/clojure/data.xml/blob/205a9df7ea77679b4d4a253a68775859fb13a1a1/src/main/clojure/clojure/data/xml.clj#L353", :raw-source-url - "https://github.com/clojure/data.xml/raw/680dc2ba7a5dab8d95eae42f6e9fd8df49902855/src/main/clojure/clojure/data/xml.clj", + "https://github.com/clojure/data.xml/raw/205a9df7ea77679b4d4a253a68775859fb13a1a1/src/main/clojure/clojure/data/xml.clj", :wiki-url "http://clojure.github.com/data.xml//clojure.data.xml-api.html#clojure.data.xml/indent", :doc "Emits the XML and indents the result. WARNING: this is slow\nit will emit the XML and read it in again to indent it. Intended for \ndebugging/testing only.", :var-type "function", - :line 294, + :line 353, :file "src/main/clojure/clojure/data/xml.clj"} {:arglists ([e]), :name "indent-str", :namespace "clojure.data.xml", :source-url - "https://github.com/clojure/data.xml/blob/680dc2ba7a5dab8d95eae42f6e9fd8df49902855/src/main/clojure/clojure/data/xml.clj#L305", + "https://github.com/clojure/data.xml/blob/205a9df7ea77679b4d4a253a68775859fb13a1a1/src/main/clojure/clojure/data/xml.clj#L364", :raw-source-url - "https://github.com/clojure/data.xml/raw/680dc2ba7a5dab8d95eae42f6e9fd8df49902855/src/main/clojure/clojure/data/xml.clj", + "https://github.com/clojure/data.xml/raw/205a9df7ea77679b4d4a253a68775859fb13a1a1/src/main/clojure/clojure/data/xml.clj", :wiki-url "http://clojure.github.com/data.xml//clojure.data.xml-api.html#clojure.data.xml/indent-str", :doc "Emits the XML and indents the result. Writes the results to a String and returns it", :var-type "function", - :line 305, + :line 364, :file "src/main/clojure/clojure/data/xml.clj"} {:arglists ([source & props]), :name "parse", :namespace "clojure.data.xml", :source-url - "https://github.com/clojure/data.xml/blob/680dc2ba7a5dab8d95eae42f6e9fd8df49902855/src/main/clojure/clojure/data/xml.clj#L238", + "https://github.com/clojure/data.xml/blob/205a9df7ea77679b4d4a253a68775859fb13a1a1/src/main/clojure/clojure/data/xml.clj#L297", :raw-source-url - "https://github.com/clojure/data.xml/raw/680dc2ba7a5dab8d95eae42f6e9fd8df49902855/src/main/clojure/clojure/data/xml.clj", + "https://github.com/clojure/data.xml/raw/205a9df7ea77679b4d4a253a68775859fb13a1a1/src/main/clojure/clojure/data/xml.clj", :wiki-url "http://clojure.github.com/data.xml//clojure.data.xml-api.html#clojure.data.xml/parse", :doc "Parses the source, which can be an\nInputStream or Reader, and returns a lazy tree of Element records. Accepts key pairs\nwith XMLInputFactory options, see http://docs.oracle.com/javase/6/docs/api/javax/xml/stream/XMLInputFactory.html\nand xml-input-factory-props for more information. Defaults coalescing true.", :var-type "function", - :line 238, + :line 297, :file "src/main/clojure/clojure/data/xml.clj"} {:arglists ([s & props]), :name "parse-str", :namespace "clojure.data.xml", :source-url - "https://github.com/clojure/data.xml/blob/680dc2ba7a5dab8d95eae42f6e9fd8df49902855/src/main/clojure/clojure/data/xml.clj#L246", + "https://github.com/clojure/data.xml/blob/205a9df7ea77679b4d4a253a68775859fb13a1a1/src/main/clojure/clojure/data/xml.clj#L305", :raw-source-url - "https://github.com/clojure/data.xml/raw/680dc2ba7a5dab8d95eae42f6e9fd8df49902855/src/main/clojure/clojure/data/xml.clj", + "https://github.com/clojure/data.xml/raw/205a9df7ea77679b4d4a253a68775859fb13a1a1/src/main/clojure/clojure/data/xml.clj", :wiki-url "http://clojure.github.com/data.xml//clojure.data.xml-api.html#clojure.data.xml/parse-str", :doc "Parses the passed in string to Clojure data structures. Accepts key pairs\nwith XMLInputFactory options, see http://docs.oracle.com/javase/6/docs/api/javax/xml/stream/XMLInputFactory.html\nand xml-input-factory-props for more information. Defaults coalescing true.", :var-type "function", - :line 246, + :line 305, :file "src/main/clojure/clojure/data/xml.clj"} {:arglists ([parent exit? node coll]), :name "seq-tree", :namespace "clojure.data.xml", :source-url - "https://github.com/clojure/data.xml/blob/680dc2ba7a5dab8d95eae42f6e9fd8df49902855/src/main/clojure/clojure/data/xml.clj#L122", + "https://github.com/clojure/data.xml/blob/205a9df7ea77679b4d4a253a68775859fb13a1a1/src/main/clojure/clojure/data/xml.clj#L121", :raw-source-url - "https://github.com/clojure/data.xml/raw/680dc2ba7a5dab8d95eae42f6e9fd8df49902855/src/main/clojure/clojure/data/xml.clj", + "https://github.com/clojure/data.xml/raw/205a9df7ea77679b4d4a253a68775859fb13a1a1/src/main/clojure/clojure/data/xml.clj", :wiki-url "http://clojure.github.com/data.xml//clojure.data.xml-api.html#clojure.data.xml/seq-tree", :doc "Takes a seq of events that logically represents\na tree by each event being one of: enter-sub-tree event,\nexit-sub-tree event, or node event.\n\nReturns a lazy sequence whose first element is a sequence of\nsub-trees and whose remaining elements are events that are not\nsiblings or descendants of the initial event.\n\nThe given exit? function must return true for any exit-sub-tree\nevent. parent must be a function of two arguments: the first is an\nevent, the second a sequence of nodes or subtrees that are children\nof the event. parent must return nil or false if the event is not\nan enter-sub-tree event. Any other return value will become\na sub-tree of the output tree and should normally contain in some\nway the children passed as the second arg. The node function is\ncalled with a single event arg on every event that is neither parent\nnor exit, and its return value will become a node of the output tree.\n\n(seq-tree #(when (= %1 :<) (vector %2)) #{:>} str\n [1 2 :< 3 :< 4 :> :> 5 :> 6])\n;=> ((\"1\" \"2\" [(\"3\" [(\"4\")])] \"5\") 6)", :var-type "function", - :line 122, + :line 121, + :file "src/main/clojure/clojure/data/xml.clj"} + {:arglists ([sexp]), + :name "sexp-as-element", + :namespace "clojure.data.xml", + :source-url + "https://github.com/clojure/data.xml/blob/205a9df7ea77679b4d4a253a68775859fb13a1a1/src/main/clojure/clojure/data/xml.clj#L219", + :raw-source-url + "https://github.com/clojure/data.xml/raw/205a9df7ea77679b4d4a253a68775859fb13a1a1/src/main/clojure/clojure/data/xml.clj", + :wiki-url + "http://clojure.github.com/data.xml//clojure.data.xml-api.html#clojure.data.xml/sexp-as-element", + :doc "Convert a single sexp into an Element", + :var-type "function", + :line 219, + :file "src/main/clojure/clojure/data/xml.clj"} + {:arglists ([] [sexp] [sexp & sexps]), + :name "sexps-as-fragment", + :namespace "clojure.data.xml", + :source-url + "https://github.com/clojure/data.xml/blob/205a9df7ea77679b4d4a253a68775859fb13a1a1/src/main/clojure/clojure/data/xml.clj#L203", + :raw-source-url + "https://github.com/clojure/data.xml/raw/205a9df7ea77679b4d4a253a68775859fb13a1a1/src/main/clojure/clojure/data/xml.clj", + :wiki-url + "http://clojure.github.com/data.xml//clojure.data.xml-api.html#clojure.data.xml/sexps-as-fragment", + :doc + "Convert a compact prxml/hiccup-style data structure into the more formal\ntag/attrs/content format. A seq of elements will be returned, which may\nnot be suitable for immediate use as there is no root element. See also\nsexp-as-element.\n\nThe format is [:tag-name attr-map? content*]. Each vector opens a new tag;\nseqs do not open new tags, and are just used for inserting groups of elements\ninto the parent tag. A bare keyword not in a vector creates an empty element.\n\nTo provide XML conversion for your own data types, extend the AsElements\nprotocol to them.", + :var-type "function", + :line 203, :file "src/main/clojure/clojure/data/xml.clj"} {:arglists ([s & {:as props}]), :name "source-seq", :namespace "clojure.data.xml", :source-url - "https://github.com/clojure/data.xml/blob/680dc2ba7a5dab8d95eae42f6e9fd8df49902855/src/main/clojure/clojure/data/xml.clj#L228", + "https://github.com/clojure/data.xml/blob/205a9df7ea77679b4d4a253a68775859fb13a1a1/src/main/clojure/clojure/data/xml.clj#L287", :raw-source-url - "https://github.com/clojure/data.xml/raw/680dc2ba7a5dab8d95eae42f6e9fd8df49902855/src/main/clojure/clojure/data/xml.clj", + "https://github.com/clojure/data.xml/raw/205a9df7ea77679b4d4a253a68775859fb13a1a1/src/main/clojure/clojure/data/xml.clj", :wiki-url "http://clojure.github.com/data.xml//clojure.data.xml-api.html#clojure.data.xml/source-seq", :doc "Parses the XML InputSource source using a pull-parser. Returns\na lazy sequence of Event records. Accepts key pairs\nwith XMLInputFactory options, see http://docs.oracle.com/javase/6/docs/api/javax/xml/stream/XMLInputFactory.html\nand xml-input-factory-props for more information. Defaults coalescing true.", :var-type "function", - :line 228, + :line 287, :file "src/main/clojure/clojure/data/xml.clj"} {:file nil, :raw-source-url nil, @@ -167,9 +194,21 @@ :name "Event"} {:file "src/main/clojure/clojure/data/xml.clj", :raw-source-url - "https://github.com/clojure/data.xml/raw/680dc2ba7a5dab8d95eae42f6e9fd8df49902855/src/main/clojure/clojure/data/xml.clj", + "https://github.com/clojure/data.xml/raw/205a9df7ea77679b4d4a253a68775859fb13a1a1/src/main/clojure/clojure/data/xml.clj", + :source-url + "https://github.com/clojure/data.xml/blob/205a9df7ea77679b4d4a253a68775859fb13a1a1/src/main/clojure/clojure/data/xml.clj#L170", + :wiki-url + "http://clojure.github.com/data.xml//clojure.data.xml-api.html#clojure.data.xml/AsElements", + :namespace "clojure.data.xml", + :line 170, + :var-type "protocol", + :doc nil, + :name "AsElements"} + {:file "src/main/clojure/clojure/data/xml.clj", + :raw-source-url + "https://github.com/clojure/data.xml/raw/205a9df7ea77679b4d4a253a68775859fb13a1a1/src/main/clojure/clojure/data/xml.clj", :source-url - "https://github.com/clojure/data.xml/blob/680dc2ba7a5dab8d95eae42f6e9fd8df49902855/src/main/clojure/clojure/data/xml.clj#L52", + "https://github.com/clojure/data.xml/blob/205a9df7ea77679b4d4a253a68775859fb13a1a1/src/main/clojure/clojure/data/xml.clj#L52", :wiki-url "http://clojure.github.com/data.xml//clojure.data.xml-api.html#clojure.data.xml/EventGeneration", :namespace "clojure.data.xml", @@ -177,6 +216,16 @@ :var-type "protocol", :doc "Protocol for generating new events based on element type", :name "EventGeneration"} + {:file nil, + :raw-source-url nil, + :source-url nil, + :wiki-url + "http://clojure.github.com/data.xml//clojure.data.xml-api.html#clojure.data.xml/as-elements", + :namespace "clojure.data.xml", + :var-type "function", + :arglists ([expr]), + :doc "Return a seq of elements represented by an expression.", + :name "as-elements"} {:file nil, :raw-source-url nil, :source-url nil, diff --git a/index.html b/index.html index 53eed62..615cf5a 100644 --- a/index.html +++ b/index.html @@ -1,7 +1,7 @@ - clojure.data.xml - Lazy XML parsing 0.0.6 API documentation + clojure.data.xml - Lazy XML parsing 0.0.7 API documentation @@ -25,7 +25,7 @@

    data.xml API
    - Lazy XML parsing 0.0.6 API
    + Lazy XML parsing 0.0.7 API
    Protocols
    + AsElements +
    + as-elements +
    +
    EventGeneration
    gen-event @@ -96,6 +101,12 @@

    Table of Contents

    seq-tree +
    + sexp-as-element + +
    + sexps-as-fragment +
    source-seq @@ -104,7 +115,7 @@

    Table of Contents

    API for clojure.data.xml - - Lazy XML parsing 0.0.6 (in development) + - Lazy XML parsing 0.0.7 (in development)

    by Chris Houser
    Full namespace name: clojure.data.xml @@ -121,6 +132,27 @@

    Overview

    Protocols

    +
    +
    +

    AsElements

    + Protocol
    + 
    
+    Known implementations: clojure.lang.IPersistentVector, clojure.lang.ISeq, clojure.lang.Keyword, java.lang.String, nil, Object
+    
    
+      
    
+      
    as-elements
    
+      function
    
+      
    Usage: (as-elements expr)
+
    
+      
    Return a seq of elements represented by an expression.
    
+      
+      
+      
+    
    
+    
+    
+    Source
+  
    
     
    
     
    
     
    EventGeneration
    
@@ -151,7 +183,7 @@ 
    next-events
    
     
    
     
     
-    Source
+    Source
   
    
 
    
 
    
@@ -210,7 +242,7 @@ 
    emit
    
  :encoding <str>          Character encoding to use
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -221,7 +253,7 @@ 
    emit-str
    
     
    Emits the Element to String and returns it
    
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -233,7 +265,7 @@ 
    event-tree
    
 objects. See source-seq and parse.
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -246,7 +278,7 @@ 
    indent
    
 debugging/testing only.
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -257,7 +289,7 @@ 
    indent-str
    
     
    Emits the XML and indents the result.  Writes the results to a String and returns it
    
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -271,7 +303,7 @@ 
    parse
    
 and xml-input-factory-props for more information. Defaults coalescing true.
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -284,7 +316,7 @@ 
    parse-str
    
 and xml-input-factory-props for more information. Defaults coalescing true.
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -315,7 +347,41 @@ 
    seq-tree
    
 ;=> (("1" "2" [("3" [("4")])] "5") 6)
     
     
-    Source
+    Source
+  
    
+    
    
+    
    
+    
    sexp-as-element
    
+    function
    
+    
    Usage: (sexp-as-element sexp)
+
    
+    
    Convert a single sexp into an Element
    
+    
+    
+    Source
+  
    
+    
    
+    
    
+    
    sexps-as-fragment
    
+    function
    
+    
    Usage: (sexps-as-fragment)
+       (sexps-as-fragment sexp)
+       (sexps-as-fragment sexp & sexps)
+
    
+    
    Convert a compact prxml/hiccup-style data structure into the more formal
+tag/attrs/content format. A seq of elements will be returned, which may
+not be suitable for immediate use as there is no root element. See also
+sexp-as-element.
+
+The format is [:tag-name attr-map? content*]. Each vector opens a new tag;
+seqs do not open new tags, and are just used for inserting groups of elements
+into the parent tag. A bare keyword not in a vector creates an empty element.
+
+To provide XML conversion for your own data types, extend the AsElements
+protocol to them.
    
+    
+    
+    Source
   
    
     
    
     
    
@@ -329,7 +395,7 @@ 
    source-seq
    
 and xml-input-factory-props for more information. Defaults coalescing true.
     
     
-    Source
+    Source