[cldoc-cvs] CVS update: cldoc/src/html.lisp cldoc/src/package.lisp

[Iban Hatchondo]

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