[cldoc-devel] Documentation tools

[Iban HATCHONDO]

--- Cody Koeninger <codykoeninger at gmail.com> a écrit :

> On 12/14/05, Erik Enge <erik.enge at gmail.com> wrote:
> >In a month or so, common-lisp.net will
> automatically generate
> >documentation for all projects with a .asd file
> every night using
> ><http://common-lisp.net/project/cldoc>.
> 
> I really like the idea behind this project -
> docstrings already are
> (should be) there, so parse them for documentation. 
> 2 concerns:
> 
> 1. How does one provide a clear "start reading here"
> or example of
> usage for the user?  Just looking at
>
http://common-lisp.net/project/cldoc/HTMLdoc/index.html
> without the hint on the homepage, I would have no
> idea that I should
> track down the extract-documentation method as a
> starting point.  Is
> the 'package' link intended to provide that hint?

Yes pretty much. But I agree that it is not obvious. I
am trying to write up a small example and 'getting
started' page for that purpose.

> 2. The documentation for CLDOC itself could use a
> little attention in
> terms of spelling / grammar (e.g "must note be
> instancied").  How can
> I (or another gardener) pitch in on that front?

I would love to have some help on this front ! I know
I should be an intensive user of M-x ispell, as a non
native english speaker, but I forgot from time to time
:)
I can either give you CVS right or you you can send me
patch I can apply and commit.
 
Cheers,
Iban.


	

	
		
___________________________________________________________________________ 
Nouveau : téléphonez moins cher avec Yahoo! Messenger ! Découvez les tarifs exceptionnels pour appeler la France et l'international.
Téléchargez sur http://fr.messenger.yahoo.com