Update for current atdoc
Fri May 16 07:53:28 PDT 2008 David Lichteblau <david@lichteblau.com>
* Update for current atdoc
Warning: CRC errors found. These are probably harmless but should be repaired.
See 'darcs gzcrcs --help' for more information.
diff -rN -u old-plexippus-xpath/doc/atdoc.lisp new-plexippus-xpath/doc/atdoc.lisp
--- old-plexippus-xpath/doc/atdoc.lisp 2014-07-10 20:27:39.000000000 -0700
+++ new-plexippus-xpath/doc/atdoc.lisp 2014-07-10 20:27:39.000000000 -0700
@@ -1,11 +1,50 @@
(asdf:operate 'asdf:load-op :xpath)
(asdf:operate 'asdf:load-op :atdoc)
+
+;;
+;; HTML (multipage)
+;;
(let* ((base (asdf:component-pathname (asdf:find-system :xpath)))
(atdoc-directory (merge-pathnames "doc/atdoc/" base)))
(ensure-directories-exist atdoc-directory)
- (atdoc:generate-documentation
+ (atdoc:generate-html-documentation
'(:xpath :xpath-sys :xpattern)
atdoc-directory
:index-title "Plexippus XPath API reference"
:heading "Plexippus XPath"
- :css (merge-pathnames "doc/atdoc.css" base)))
+
+ ;; suppress pages for unexported symbols, which we don't really need.
+ ;; ... and Xuriella is currently too slow for so many pages.
+ :include-internal-symbols-p nil
+
+ ;; For now, use atdoc's new default stylesheet
+ ;; (I think it looks a little better than the old stuff.)
+ ;; :css (merge-pathnames "doc/atdoc.css" base)
+ ))
+
+;;
+;; HTML (single page)
+;;
+#+(or)
+(let* ((base (asdf:component-pathname (asdf:find-system :xpath)))
+ (atdoc-directory (merge-pathnames "doc/atdoc/" base)))
+ (ensure-directories-exist atdoc-directory)
+ (atdoc:generate-html-documentation
+ '(:xpath :xpath-sys :xpattern)
+ atdoc-directory
+ :index-title "Plexippus XPath API reference"
+ :heading "Plexippus XPath"
+ :single-page-p t))
+
+;;
+;; LaTeX/PDF
+;;
+
+#+(or)
+(let* ((base (asdf:component-pathname (asdf:find-system :xpath)))
+ (atdoc-directory (merge-pathnames "doc/atdoc/" base)))
+ (ensure-directories-exist atdoc-directory)
+ (atdoc:generate-latex-documentation
+ '(:xpath :xpath-sys :xpattern)
+ atdoc-directory
+ :title "Plexippus XPath"))
diff -rN -u old-plexippus-xpath/doc/index.xsl new-plexippus-xpath/doc/index.xsl
--- old-plexippus-xpath/doc/index.xsl 2014-07-10 20:27:39.000000000 -0700
+++ new-plexippus-xpath/doc/index.xsl 2014-07-10 20:27:39.000000000 -0700
@@ -103,8 +103,7 @@
<br/>&#160;
</li>
<li>
- <a href="atdoc/index.html"><strike>API documentation</strike></a>
- (to be written)
+ <a href="atdoc/index.html">API documentation</a>
</li>
</ul>
</div>
diff -rN -u old-plexippus-xpath/pipes.lisp new-plexippus-xpath/pipes.lisp
--- old-plexippus-xpath/pipes.lisp 2014-07-10 20:27:39.000000000 -0700
+++ new-plexippus-xpath/pipes.lisp 2014-07-10 20:27:39.000000000 -0700
@@ -70,7 +70,7 @@
"@arg[pipe]{a pipe}
@arg[count]{a non-negative integer}
@arg[key]{a function}
- @arg[result]{an object]
+ @arg[result]{an object}
@return{the value of @key{result} (the value of @code{pipe} by default)}
Goes through all or @code{count} elements of pipe,
possibly applying the @code{key} function."
diff -rN -u old-plexippus-xpath/types.lisp new-plexippus-xpath/types.lisp
--- old-plexippus-xpath/types.lisp 2014-07-10 20:27:39.000000000 -0700
+++ new-plexippus-xpath/types.lisp 2014-07-10 20:27:39.000000000 -0700
@@ -42,7 +42,10 @@
(defclass node-set ()
((pipe :initform empty-pipe :initarg :pipe)
(ordering :accessor ordering-of :initform :unordered :initarg :ordering))
- (:documentation "Represents an XPath node set"))
+ (:documentation
+ "Represents an XPath node set
+
+ @see-constructor{make-node-set}"))
(defun pipe-of (node-set)
"@arg[node-set]{a node set}