[cldoc-cvs] CVS cldoc/src

[ihatchondo]

Update of /project/cldoc/cvsroot/cldoc/src
In directory clnet:/tmp/cvs-serv27468

Modified Files:
	cludg.lisp 
Log Message:
Documentation updateas suggested by marco.

--- /project/cldoc/cvsroot/cldoc/src/cludg.lisp	2006/12/06 22:50:27	1.6
+++ /project/cldoc/cvsroot/cldoc/src/cludg.lisp	2006/12/08 10:08:05	1.7
@@ -1,5 +1,5 @@
 ;;; -*- Mode: Lisp; Syntax: Common-Lisp; Package: CLUDG; -*-
-;;; $Id: cludg.lisp,v 1.6 2006/12/06 22:50:27 ihatchondo Exp $
+;;; $Id: cludg.lisp,v 1.7 2006/12/08 10:08:05 ihatchondo Exp $
 ;;; ---------------------------------------------------------------------------
 ;;;     Title: Common Lisp Universal Documentation Generator
 ;;;   Created: 2005 10 23 12:30
@@ -28,8 +28,13 @@
 
 (defgeneric extract-documentation (driver dest-dir filenames &rest initargs)
   (:documentation "Reads all files specified in filenames and extract their
-   documentation using the specified output-format driver. If filenames is
-   an ASDF system then its components files will be retreived first.
+   documentation using the specified output-format driver.
+    Because it is performing some symbol package resolution it needs packages
+   definition to be, at least loaded. A simple way to satisfy this condition
+   is to load, such as require would, the systems to be documented before
+   starting documentation extraction.
+    If filenames is an ASDF system then its components files will be retreived
+   first.
     The extracted documentation will be written in a newly created file
    with the same name as the processed one but with the filename extension
    relatives to the output driver. If dest-dir is non NIL then it will be