January 2006 - cldoc-cvs@common-lisp.net - mailman3.common-lisp.net

[cldoc-cvs] CVS update: cldoc/src/package.lisp
by ihatchondo＠common-lisp.net 09 Jan '06

09 Jan '06

Update of /project/cldoc/cvsroot/cldoc/src In directory common-lisp.net:/tmp/cvs-serv4604/src Modified Files: package.lisp Log Message: removed non ascii space char. Date: Mon Jan 9 23:32:13 2006 Author: ihatchondo Index: cldoc/src/package.lisp diff -u cldoc/src/package.lisp:1.5 cldoc/src/package.lisp:1.6 --- cldoc/src/package.lisp:1.5 Mon Jan 9 23:23:43 2006 +++ cldoc/src/package.lisp Mon Jan 9 23:32:12 2006 @@ -1,5 +1,5 @@ ;;; -*- Mode: Lisp; Syntax: Common-Lisp; Package: CLUDG; -*- -;;; $Id: package.lisp,v 1.5 2006/01/09 22:23:43 ihatchondo Exp $ +;;; $Id: package.lisp,v 1.6 2006/01/09 22:32:12 ihatchondo Exp $ ;;; --------------------------------------------------------------------------- ;;; Title: Common Lisp Universal Documentation Generator package definition ;;; Created: 2005 10 23 12:30

1 0

[cldoc-cvs] CVS update: cldoc/COPYING cldoc/INSTALL cldoc/README
by ihatchondo＠common-lisp.net 09 Jan '06

09 Jan '06

Update of /project/cldoc/cvsroot/cldoc In directory common-lisp.net:/tmp/cvs-serv4572 Modified Files: COPYING INSTALL README Log Message: removed non ascii space char. Date: Mon Jan 9 23:31:50 2006 Author: ihatchondo

1 0

[cldoc-cvs] CVS update: cldoc/src/package.lisp
by ihatchondo＠common-lisp.net 09 Jan '06

09 Jan '06

Update of /project/cldoc/cvsroot/cldoc/src In directory common-lisp.net:/tmp/cvs-serv3411 Modified Files: package.lisp Log Message: removed non ascii space char. Date: Mon Jan 9 23:23:43 2006 Author: ihatchondo Index: cldoc/src/package.lisp diff -u cldoc/src/package.lisp:1.4 cldoc/src/package.lisp:1.5 --- cldoc/src/package.lisp:1.4 Sun Jan 8 23:18:27 2006 +++ cldoc/src/package.lisp Mon Jan 9 23:23:43 2006 @@ -1,5 +1,5 @@ ;;; -*- Mode: Lisp; Syntax: Common-Lisp; Package: CLUDG; -*- -;;; $Id: package.lisp,v 1.4 2006/01/08 22:18:27 ihatchondo Exp $ +;;; $Id: package.lisp,v 1.5 2006/01/09 22:23:43 ihatchondo Exp $ ;;; --------------------------------------------------------------------------- ;;; Title: Common Lisp Universal Documentation Generator package definition ;;; Created: 2005 10 23 12:30 @@ -80,7 +80,7 @@ - Recognizes code segments: by default each lines are prefixed with ';;; '. - Recognizes links: two kinds of hyper link are possible both using the same grammar: - [opening-char(defun|defclass|defgeneric|...) symbol-name closing-char] | + [opening-char(defun|defclass|defgeneric|...) symbol-name closing-char] | [opening-char(http://|ftp://)address closing-char]. opening-char and closing char can be customized, see the :link-delimiters option of {defclass cldoc:doctree} .

1 0

[cldoc-cvs] CVS update: cldoc/src/html.lisp cldoc/src/package.lisp
by ihatchondo＠common-lisp.net 08 Jan '06

08 Jan '06

Update of /project/cldoc/cvsroot/cldoc/src In directory common-lisp.net:/tmp/cvs-serv16258/src Modified Files: html.lisp package.lisp Log Message: package def updated and cosmetic changes. Date: Sun Jan 8 23:18:33 2006 Author: ihatchondo Index: cldoc/src/html.lisp diff -u cldoc/src/html.lisp:1.10 cldoc/src/html.lisp:1.11 --- cldoc/src/html.lisp:1.10 Sun Jan 8 17:49:16 2006 +++ cldoc/src/html.lisp Sun Jan 8 23:18:26 2006 @@ -1,5 +1,5 @@ ;;; -*- Mode: Lisp; Syntax: Common-Lisp; Package: CLUDG; -*- -;;; $Id: html.lisp,v 1.10 2006/01/08 16:49:16 ihatchondo Exp $ +;;; $Id: html.lisp,v 1.11 2006/01/08 22:18:26 ihatchondo Exp $ ;;; --------------------------------------------------------------------------- ;;; Title: Common Lisp Universal Documentation Generator: HTML driver ;;; Created: 2005 10 23 2:30 @@ -514,8 +514,7 @@ (with-tag (:a (:href file)) (if (string/= name "the-index") (html-write "~d ~a~%" (incf i) name) - (html-write " Index")))))))))) - (truename toc))) + (html-write " Index")))))))))))) (defun get-defpackage-descriptor (meta-descriptors package-table) "Finds all the defpackage-descriptor and insert them in the package-table." @@ -635,7 +634,7 @@ defmacro descriptors if any." ;; Because neither the defstruct nor the defclass nor the define-condition ;; accessors are present in the list of descriptors they will be retrieved - ;; manually and added to defun or defmethod list before make-summary call. + ;; manually and added to defun or defmethod list before call make-summary. (flet ((mapconc (fun list) (apply #'concatenate 'list (mapcar fun list)))) (let* ((defmethods '(or defgeneric-descriptor defmethod-descriptor)) (defuns '(or defun-descriptor defsetf-descriptor)) Index: cldoc/src/package.lisp diff -u cldoc/src/package.lisp:1.3 cldoc/src/package.lisp:1.4 --- cldoc/src/package.lisp:1.3 Sun Jan 8 17:49:16 2006 +++ cldoc/src/package.lisp Sun Jan 8 23:18:27 2006 @@ -1,5 +1,5 @@ ;;; -*- Mode: Lisp; Syntax: Common-Lisp; Package: CLUDG; -*- -;;; $Id: package.lisp,v 1.3 2006/01/08 16:49:16 ihatchondo Exp $ +;;; $Id: package.lisp,v 1.4 2006/01/08 22:18:27 ihatchondo Exp $ ;;; --------------------------------------------------------------------------- ;;; Title: Common Lisp Universal Documentation Generator package definition ;;; Created: 2005 10 23 12:30 @@ -27,7 +27,8 @@ #:*class-inheritence* #:*condition-inheritence* #:*struct-inheritence* #:*slot-reader-control-string* #:*slot-writer-control-string* #:*slot-accessor-control-string* - #:+html-doctype+ #:+default-charset+ + #:+html-doctype+ #:+default-charset+ #:+default-link-delimiters+ + #:+default-section-prefix+ #:+default-code-prefix+ #:+default-section-names+ #:define-descriptor-handler #:find-descriptor-handler #:register-output-type @@ -40,7 +41,6 @@ #:html #:text #:extract-documentation - #:make-doc #:dformat #:dformat-documentation ;; cache system. @@ -48,7 +48,7 @@ #:meta-descriptor-href #:meta-descriptor-desc #:meta-descriptor-file #:clear-cache #:cache-descriptor #:initialise-cache #:lookup-meta-descriptor #:lookup-meta-descriptor-anchor - #:lookup-meta-descriptor-href + #:lookup-meta-descriptor-href #:cache-meta-descriptors ;; documentation string parsing utilities #:doctree #:doctree-tree

1 0

[cldoc-cvs] CVS update: cldoc/README
by ihatchondo＠common-lisp.net 08 Jan '06

08 Jan '06

Update of /project/cldoc/cvsroot/cldoc In directory common-lisp.net:/tmp/cvs-serv25219 Modified Files: README Log Message: Link support added. Date: Sun Jan 8 18:19:31 2006 Author: ihatchondo Index: cldoc/README diff -u cldoc/README:1.1.1.1 cldoc/README:1.2 --- cldoc/README:1.1.1.1 Fri Nov 18 15:52:17 2005 +++ cldoc/README Sun Jan 8 18:19:31 2006 @@ -14,9 +14,8 @@ - Recognizes bulleted lists (the list grammar can be specified). - Recognizes code segments: by default each lines are prefixed with ';;; '. - - should be added to the DWIM: - - links. how ? + - Recognizes links: for standard URL's and symbol referencing. + (see the :link-delimiters option of the doctree class). Unlike Albert (http://albert.sourceforge.net/) it does not allow programmers to insert comments at the source code level which are

1 0

[cldoc-cvs] CVS update: public_html/documentation.html
by ihatchondo＠common-lisp.net 08 Jan '06

08 Jan '06

Update of /project/cldoc/cvsroot/public_html In directory common-lisp.net:/tmp/cvs-serv24765 Modified Files: documentation.html Log Message: Link are supported. Date: Sun Jan 8 18:16:28 2006 Author: ihatchondo Index: public_html/documentation.html diff -u public_html/documentation.html:1.2 public_html/documentation.html:1.3 --- public_html/documentation.html:1.2 Sat Nov 19 20:04:11 2005 +++ public_html/documentation.html Sun Jan 8 18:16:26 2006 @@ -155,9 +155,11 @@ Recognizes code segments: by default each lines are prefixed with ';;; '. </li> + <li> + Recognizes links: for standard URL's and symbol referencing. + (see the :link-delimiters option of the <a href="HTMLdoc/string-parser.html">doctree class</a>). + </li> </ul> - should be added to the DWIM: - <ul><li>links. how ?</li></ul> Install

1 0

[cldoc-cvs] CVS update: cldoc/src/html.lisp cldoc/src/package.lisp
by ihatchondo＠common-lisp.net 08 Jan '06

08 Jan '06

Update of /project/cldoc/cvsroot/cldoc/src In directory common-lisp.net:/tmp/cvs-serv22814 Modified Files: html.lisp package.lisp Log Message: doc updated. Date: Sun Jan 8 17:49:17 2006 Author: ihatchondo Index: cldoc/src/html.lisp diff -u cldoc/src/html.lisp:1.9 cldoc/src/html.lisp:1.10 --- cldoc/src/html.lisp:1.9 Sun Jan 8 17:12:18 2006 +++ cldoc/src/html.lisp Sun Jan 8 17:49:16 2006 @@ -1,5 +1,5 @@ ;;; -*- Mode: Lisp; Syntax: Common-Lisp; Package: CLUDG; -*- -;;; $Id: html.lisp,v 1.9 2006/01/08 16:12:18 ihatchondo Exp $ +;;; $Id: html.lisp,v 1.10 2006/01/08 16:49:16 ihatchondo Exp $ ;;; --------------------------------------------------------------------------- ;;; Title: Common Lisp Universal Documentation Generator: HTML driver ;;; Created: 2005 10 23 2:30 @@ -681,7 +681,7 @@ (values T (format nil "~{~a~^ ~}" strings)) (multiple-value-bind (name package) (split-name (second strings)) (let ((href (lookup-meta-descriptor-href - name (first strings) package file))) + (or name "") (first strings) package file))) (values (if href T NIL) href name)))))) (defun format-doc (symdesc html-driver strings) Index: cldoc/src/package.lisp diff -u cldoc/src/package.lisp:1.2 cldoc/src/package.lisp:1.3 --- cldoc/src/package.lisp:1.2 Thu Jan 5 15:47:11 2006 +++ cldoc/src/package.lisp Sun Jan 8 17:49:16 2006 @@ -1,5 +1,5 @@ ;;; -*- Mode: Lisp; Syntax: Common-Lisp; Package: CLUDG; -*- -;;; $Id: package.lisp,v 1.2 2006/01/05 14:47:11 ihatchondo Exp $ +;;; $Id: package.lisp,v 1.3 2006/01/08 16:49:16 ihatchondo Exp $ ;;; --------------------------------------------------------------------------- ;;; Title: Common Lisp Universal Documentation Generator package definition ;;; Created: 2005 10 23 12:30 @@ -78,9 +78,21 @@ - Recognize both indent and empty-line paragraph breaks. - Recognizes bulleted lists (the list grammar can be specified). - Recognizes code segments: by default each lines are prefixed with ';;; '. - - should be added to the DWIM: - - links. how ? + - Recognizes links: two kinds of hyper link are possible both using the + same grammar: + [opening-char(defun|defclass|defgeneric|...) symbol-name closing-char] | + [opening-char(http://|ftp://)address closing-char]. + opening-char and closing char can be customized, see the :link-delimiters + option of {defclass cldoc:doctree} . + + ;;; (defun foo () + ;;; \"-- URL's: {http://common-lisp.net/cldoc} + ;;; -- Common Lisp symbols: {defgeneric cldoc:extract-documentation}\" + ;;; (values)) + + will produce: + -- URL's: {http://common-lisp.net/cldoc} + -- Common Lisp symbols: {defgeneric cldoc:extract-documentation} Unlike Albert, {http://albert.sourceforge.net} , it does not allow programmers to insert comments at the source code level which are

1 0

[cldoc-cvs] CVS update: cldoc/src/cludg.lisp cldoc/src/html.lisp
by ihatchondo＠common-lisp.net 08 Jan '06

08 Jan '06

Update of /project/cldoc/cvsroot/cldoc/src In directory common-lisp.net:/tmp/cvs-serv19285 Modified Files: cludg.lisp html.lisp Log Message: title attribute added in the general symbol index href. The title attribute will show the fully qualified name of the symbol and its lambda list when this symbol is 'lambda-descriptor' symbol. Date: Sun Jan 8 17:12:18 2006 Author: ihatchondo Index: cldoc/src/cludg.lisp diff -u cldoc/src/cludg.lisp:1.4 cldoc/src/cludg.lisp:1.5 --- cldoc/src/cludg.lisp:1.4 Thu Jan 5 15:47:11 2006 +++ cldoc/src/cludg.lisp Sun Jan 8 17:12:17 2006 @@ -1,5 +1,5 @@ ;;; -*- Mode: Lisp; Syntax: Common-Lisp; Package: CLUDG; -*- -;;; $Id: cludg.lisp,v 1.4 2006/01/05 14:47:11 ihatchondo Exp $ +;;; $Id: cludg.lisp,v 1.5 2006/01/08 16:12:17 ihatchondo Exp $ ;;; --------------------------------------------------------------------------- ;;; Title: Common Lisp Universal Documentation Generator ;;; Created: 2005 10 23 12:30 @@ -347,6 +347,16 @@ :reader allocation-type)) (:documentation "This descripor is made for describe the slots of class, conditon and structure.")) + +(defgeneric fully-qualified-name (symbol-descriptor) + (:documentation "Returns the string that represent the fully qualified + name of the given symbol-descriptor.") + (:method ((symdesc symbol-descriptor)) + (with-slots ((pname package) name) symdesc + (multiple-value-bind (sym status) + (find-symbol (standard-io-name name) (find-package-caseless pname)) + (declare (ignore sym)) + (format nil "~(~a~):~:[~;:~]~a" pname (eq status :internal) name))))) ;;; ;;; Common Lisp common descripor classes. Index: cldoc/src/html.lisp diff -u cldoc/src/html.lisp:1.8 cldoc/src/html.lisp:1.9 --- cldoc/src/html.lisp:1.8 Thu Jan 5 16:08:06 2006 +++ cldoc/src/html.lisp Sun Jan 8 17:12:18 2006 @@ -1,5 +1,5 @@ ;;; -*- Mode: Lisp; Syntax: Common-Lisp; Package: CLUDG; -*- -;;; $Id: html.lisp,v 1.8 2006/01/05 15:08:06 ihatchondo Exp $ +;;; $Id: html.lisp,v 1.9 2006/01/08 16:12:18 ihatchondo Exp $ ;;; --------------------------------------------------------------------------- ;;; Title: Common Lisp Universal Documentation Generator: HTML driver ;;; Created: 2005 10 23 2:30 @@ -403,6 +403,15 @@ ;;; HTML index creation facilities ;;; +(defgeneric href-title (symbol-descriptor) + (:documentation "Returns a string for the title attribute of an href.") + (:method ((symdesc symbol-descriptor)) + (purge-string-for-html (fully-qualified-name symdesc))) + (:method ((symdesc lambda-descriptor)) + (let ((name (purge-string-for-html (fully-qualified-name symdesc))) + (ll (format nil "(~{~s~^ ~})" (lambda-list symdesc)))) + (concatenate 'string name " " (purge-string-for-html ll))))) + (defmacro with-index-header ((index hdriver dest-dir title &key (head-title title)) &body body) (with-gensym (href ttitle iindex ddir) @@ -448,7 +457,8 @@ if (or (and entry (first-char-p (name desc) entry)) non-alphabetic) do (unless (and filter (funcall filter desc)) (with-tag (:div (:class "index-entry")) - (with-tag (:a (:href (meta-descriptor-href mdesc))) + (with-tag (:a (:href (meta-descriptor-href mdesc) + :title (href-title desc))) (html-write "~a," (purge-string-for-html (name desc)))) (with-tag (:em ()) (html-write "~a" (html-printable-type desc)))))

1 0

[cldoc-cvs] CVS update: cldoc/src/html.lisp
by ihatchondo＠common-lisp.net 05 Jan '06

05 Jan '06

Update of /project/cldoc/cvsroot/cldoc/src In directory common-lisp.net:/tmp/cvs-serv32466 Modified Files: html.lisp Log Message: Fix invalid (when) expression in resolve-link. Date: Thu Jan 5 16:08:06 2006 Author: ihatchondo Index: cldoc/src/html.lisp diff -u cldoc/src/html.lisp:1.7 cldoc/src/html.lisp:1.8 --- cldoc/src/html.lisp:1.7 Thu Jan 5 15:54:11 2006 +++ cldoc/src/html.lisp Thu Jan 5 16:08:06 2006 @@ -1,5 +1,5 @@ ;;; -*- Mode: Lisp; Syntax: Common-Lisp; Package: CLUDG; -*- -;;; $Id: html.lisp,v 1.7 2006/01/05 14:54:11 ihatchondo Exp $ +;;; $Id: html.lisp,v 1.8 2006/01/05 15:08:06 ihatchondo Exp $ ;;; --------------------------------------------------------------------------- ;;; Title: Common Lisp Universal Documentation Generator: HTML driver ;;; Created: 2005 10 23 2:30 @@ -672,7 +672,7 @@ (multiple-value-bind (name package) (split-name (second strings)) (let ((href (lookup-meta-descriptor-href name (first strings) package file))) - (when (values T href name))))))) + (values (if href T NIL) href name)))))) (defun format-doc (symdesc html-driver strings) "Default documentation string formater. The Do What I Mean capabilities

1 0

[cldoc-cvs] CVS update: cldoc/src/html.lisp
by ihatchondo＠common-lisp.net 05 Jan '06

05 Jan '06

Update of /project/cldoc/cvsroot/cldoc/src In directory common-lisp.net:/tmp/cvs-serv31320 Modified Files: html.lisp Log Message: Typo fix Date: Thu Jan 5 15:54:11 2006 Author: ihatchondo Index: cldoc/src/html.lisp diff -u cldoc/src/html.lisp:1.6 cldoc/src/html.lisp:1.7 --- cldoc/src/html.lisp:1.6 Thu Jan 5 15:47:11 2006 +++ cldoc/src/html.lisp Thu Jan 5 15:54:11 2006 @@ -1,5 +1,5 @@ ;;; -*- Mode: Lisp; Syntax: Common-Lisp; Package: CLUDG; -*- -;;; $Id: html.lisp,v 1.6 2006/01/05 14:47:11 ihatchondo Exp $ +;;; $Id: html.lisp,v 1.7 2006/01/05 14:54:11 ihatchondo Exp $ ;;; --------------------------------------------------------------------------- ;;; Title: Common Lisp Universal Documentation Generator: HTML driver ;;; Created: 2005 10 23 2:30 @@ -706,7 +706,7 @@ ;; it was initially found. (html-write "~a~{~a~^ ~}~a" left-link-delim - (reverse link)1 + (reverse link) right-link-delim))))) (t (with-tag ((tree-tag element) ()) (map-over-tree element))))))))

1 0