From 39259a42aeb7f8835e621abdfd681f6ca2992703 Mon Sep 17 00:00:00 2001
From: David Lichteblau <david@lichteblau.com>
Date: Sun, 6 May 2007 18:21:31 +0200
Subject: [PATCH] param documentiert

---
 index.html   | 13 ++++++-------
 package.lisp |  5 ++++-
 parse.lisp   |  4 +---
 types.lisp   | 29 +++++++++++++++++++++++++++++
 4 files changed, 40 insertions(+), 11 deletions(-)

diff --git a/index.html b/index.html
index 68ac30f..0b9a869 100644
--- a/index.html
+++ b/index.html
@@ -44,15 +44,14 @@
   <h3>Download and Installation</h3>
 
   <p>
-    Download
-    cxml-rng <a href="http://www.lichteblau.com/cxml-rng/download/">tarballs</a>
-    or get it from
-    git: <tt>http://www.lichteblau.com/git/cxml-rng.git</tt>
+    Download cxml-rng
+    <a href="http://www.lichteblau.com/cxml-rng/download/">tarballs</a>
+    or get it from git: <tt>http://www.lichteblau.com/git/cxml-rng.git</tt>
   </p>
   <p>
-    cxml-rng
-    needs <a href="http://common-lisp.net/project/cxml">Closure
-      XML</a>, <a href="http://weitz.de/cl-ppcre/">CL-PPCE</a>,
+    cxml-rng needs
+    <a href="http://common-lisp.net/project/cxml">Closure XML</a>, 
+    <a href="http://weitz.de/cl-ppcre/">CL-PPCE</a>,
     <a href="http://www.pps.jussieu.fr/~jch/software/cl-yacc/">CL-Yacc</a>,
     <a href="http://www.cliki.net/PARSE-NUMBER">parse-number</a>,
     and <a href="http://www.cliki.net/cl-base64">cl-base64</a>.
diff --git a/package.lisp b/package.lisp
index 7f4e09a..6fa7dd2 100644
--- a/package.lisp
+++ b/package.lisp
@@ -121,6 +121,7 @@
 	   #:type-context-dependent-p
 	   #:parse
 	   #:equal-using-type
+	   #:lessp-using-type
 	   #:validp
 	   #:validation-context
 	   #:sax-validation-context-mixin
@@ -221,11 +222,13 @@ T
       @fun{parse} will compute the string's @emph{value}, and return a
       Lisp object of a type-specific class as a representation of that value.
       Values returned by @fun{parse} can be compared for equality using
-      @fun{equal-using-type}.
+      @fun{equal-using-type}.  Some types also define a partial ordering,
+      which can be queried using @fun{lessp-using-type}.
 
       @aboutfun{validp}
       @aboutfun{parse}
       @aboutfun{equal-using-type}
+      @aboutfun{lessp-using-type}
     @end{section}
     @begin[The validation context]{section}
       Some types are context dependent, as indicated by
diff --git a/parse.lisp b/parse.lisp
index 689afa5..7e1aa08 100644
--- a/parse.lisp
+++ b/parse.lisp
@@ -472,9 +472,7 @@
 (setf (documentation 'pattern-params 'function)
       "@arg[instance]{an instance of @class{data}}
        @return{a list of @fun{cxml-types:param}}
-       @short{fixme}
-
-       The data type parameters for this data pattern.
+       @short{The data type parameters for this data pattern.}
 
        (With the XSD type library, these are known as restricting facets.)")
 
diff --git a/types.lisp b/types.lisp
index f214977..006749c 100644
--- a/types.lisp
+++ b/types.lisp
@@ -29,9 +29,38 @@
 (in-package :cxml-types)
 
 (defstruct (param (:constructor make-param (name value)))
+  "@short{A named data type parameter.}
+
+   (With the XSD type library, parameters are known as restricting facets.)
+   @see-constructor{make-param}
+   @see{find-type}
+   @see{cxml-rng:pattern-params}
+   @see{cxml-rng:data}
+   @see-slot{param-name}
+   @see-slot{param-value}"
   name
   value)
 
+(setf (documentation 'make-param 'function)
+      "@arg[name]{paramater name, a string}
+       @arg[value]{paramater value, a string}
+       @return{a @class{param}}
+       Create a data type parameter.
+       @see{param-name}
+       @see{param-value}")
+
+(setf (documentation 'param-name 'function)
+      "@arg[instance]{an instance of @class{param}}
+       @return{a string}
+       The data type parameter's name.
+       @see{param-value}")
+
+(setf (documentation 'param-value 'function)
+      "@arg[instance]{an instance of @class{param}}
+       @return{a string}
+       The data type parameter's value.
+       @see{param-name}")
+
 (defclass data-type () ()
   (:documentation
    "@short{The abstract superclass of all types.}
-- 
2.11.4.GIT