update documentation

clj-commons · Dec 24, 2010 · 66b59e5 · 66b59e5
1 parent a4533f0
commit 66b59e5
Show file tree

Hide file tree

Showing 13 changed files with 31 additions and 15 deletions.
diff --git a/.gitignore b/.gitignore
@@ -3,4 +3,5 @@ pom.xml
 lib
 classes
 .DS_Store
-push
+push
+autodoc
diff --git a/src/gloss/core.clj b/src/gloss/core.clj
@@ -86,7 +86,7 @@
 
    A string with :delimiters specified is terminated by one or more delimiters:
 
-   (string :utf-8 :delimiters [\"\r\n\" \"\n\"])"
+   (string :utf-8 :delimiters [\"\\r\\n\" \"\\r\"])"
   [charset & {:as options}]
   (let [charset (name charset)]
     (cond
@@ -160,7 +160,7 @@
    But may also be a more complex frame:
 
    (prefix
-     [(string :utf-8 :delimiters [\"\0\"]) :int64]
+     [(string :utf-8 :delimiters [\"\\0\"]) :int64]
      second
      (fn [n] [\"hello\" n]))
 

diff --git a/src/gloss/core/codecs.clj b/src/gloss/core/codecs.clj
@@ -6,7 +6,8 @@
 ;;   the terms of this license.
 ;;   You must not remove this notice, or any other, from this software.
 
-(ns gloss.core.codecs
+(ns ^{:skip-wiki true}
+  gloss.core.codecs
   (:use
     [gloss.data bytes string primitives]
     [gloss.core protocols structure formats]))

diff --git a/src/gloss/core/formats.clj b/src/gloss/core/formats.clj
@@ -6,7 +6,8 @@
 ;;   the terms of this license.
 ;;   You must not remove this notice, or any other, from this software.
 
-(ns gloss.core.formats
+(ns ^{:skip-wiki true}
+  gloss.core.formats
   (:import
     [java.nio
      Buffer

diff --git a/src/gloss/core/protocols.clj b/src/gloss/core/protocols.clj
@@ -6,7 +6,8 @@
 ;;   the terms of this license.
 ;;   You must not remove this notice, or any other, from this software.
 
-(ns gloss.core.protocols
+(ns ^{:skip-wiki true}
+  gloss.core.protocols
   (:use [gloss.core formats])
   (:import [java.nio Buffer ByteBuffer]))
 

diff --git a/src/gloss/core/structure.clj b/src/gloss/core/structure.clj
@@ -6,7 +6,8 @@
 ;;   the terms of this license.
 ;;   You must not remove this notice, or any other, from this software.
 
-(ns gloss.core.structure
+(ns ^{:skip-wiki true}
+  gloss.core.structure
   (:use
     [clojure.walk]
     [gloss.core protocols]
@@ -96,7 +97,11 @@
 
 (defn compile-frame
   "Takes a frame, and returns a codec.  This function is idempotent; passing in a codec
-   is a safe operation."
+   is a safe operation.
+
+   Functions that transform the values after they are decoded and before they are encoded
+   can be specified, which allows the frame to only be an intermediate representation of
+   the final Clojure data structure."
   ([frame]
      (if (reader? frame)
        frame

diff --git a/src/gloss/data/bytes.clj b/src/gloss/data/bytes.clj
@@ -6,7 +6,8 @@
 ;;   the terms of this license.
 ;;   You must not remove this notice, or any other, from this software.
 
-(ns gloss.data.bytes
+(ns ^{:skip-wiki true}
+  gloss.data.bytes
   (:use
     [potemkin]
     [gloss.core formats protocols])

diff --git a/src/gloss/data/bytes/core.clj b/src/gloss/data/bytes/core.clj
@@ -6,7 +6,8 @@
 ;;   the terms of this license.
 ;;   You must not remove this notice, or any other, from this software.
 
-(ns gloss.data.bytes.core
+(ns ^{:skip-wiki true}
+  gloss.data.bytes.core
   (:import
     [java.nio
      Buffer

diff --git a/src/gloss/data/bytes/delimited.clj b/src/gloss/data/bytes/delimited.clj
@@ -6,7 +6,8 @@
 ;;   the terms of this license.
 ;;   You must not remove this notice, or any other, from this software.
 
-(ns gloss.data.bytes.delimited
+(ns ^{:skip-wiki true}
+  gloss.data.bytes.delimited
   (:use
     gloss.data.bytes.core
     gloss.core.protocols

diff --git a/src/gloss/data/primitives.clj b/src/gloss/data/primitives.clj
@@ -6,7 +6,8 @@
 ;;   the terms of this license.
 ;;   You must not remove this notice, or any other, from this software.
 
-(ns gloss.data.primitives
+(ns ^{:skip-wiki true}
+  gloss.data.primitives
   (:use
     [gloss.data bytes]
     [gloss.core protocols])

diff --git a/src/gloss/data/string.clj b/src/gloss/data/string.clj
@@ -6,7 +6,8 @@
 ;;   the terms of this license.
 ;;   You must not remove this notice, or any other, from this software.
 
-(ns gloss.data.string
+(ns ^{:skip-wiki true}
+  gloss.data.string
   (:use
     [potemkin])
   (:require

diff --git a/src/gloss/data/string/codecs.clj b/src/gloss/data/string/codecs.clj
@@ -6,7 +6,8 @@
 ;;   the terms of this license.
 ;;   You must not remove this notice, or any other, from this software.
 
-(ns gloss.data.string.codecs
+(ns ^{:skip-wiki true}
+  gloss.data.string.codecs
   (:use
     [gloss.core formats protocols]
     [gloss.data.bytes]

diff --git a/src/gloss/data/string/core.clj b/src/gloss/data/string/core.clj
@@ -6,7 +6,8 @@
 ;;   the terms of this license.
 ;;   You must not remove this notice, or any other, from this software.
 
-(ns gloss.data.string.core
+(ns ^{:skip-wiki true}
+  gloss.data.string.core
   (:use
     [gloss.data bytes])
   (:import