Re: Generating documentation for Lisp

On Tue, Jul 22, 2008 at 05:31:03PM +0200, Mauricio Toro wrote:
> I have some methods and classes defined this way:
> 
> (defmethod g-or+ ((self ge-regexp) n)
>   "OR regula expr self with integer n one or more times"
>   (if (exists self)
>     (ge-reg_or_+ (slot-value self 'gecode-regexp) n)
>     (error "uninitialized or dead regular expression")))
> 
> I would like to generate an html and pdf with the documentation.
> Any clues how can this be done automatically?

These may work, or at least provide a place to start.

http://www.cliki.net/LispDoc
http://www.cliki.net/CL-PDF

I haven't used either one, this is just from a quick Google based on
half-remembered package names.

-- L

Re: Generating documentation for Lisp

Mauricio Toro wrote:
> Hello,
> 
> I have some methods and classes defined this way:
> 
> (defmethod g-or+ ((self ge-regexp) n)
>   "OR regula expr self with integer n one or more times"
>   (if (exists self)
>     (ge-reg_or_+ (slot-value self 'gecode-regexp) n)
>     (error "uninitialized or dead regular expression")))
> 
> I would like to generate an html and pdf with the documentation.
> Any clues how can this be done automatically?

Have you seen this page?

http://www.cliki.net/Documentation%20tool


-- 
Chris Riesbeck

Home page: http://www.cs.northwestern.edu/~riesbeck/
Calendar: http://calendar.yahoo.com/criesbeck

Re: Generating documentation for Lisp

Depending on the degree of automation you require, you may also want  
to look at docudown

http://common-lisp.net/project/docudown


On Jul 22, 2008, at 11:31 AM, Mauricio Toro wrote:

> Hello,
>
> I have some methods and classes defined this way:
>
> (defmethod g-or+ ((self ge-regexp) n)
>   "OR regula expr self with integer n one or more times"
>   (if (exists self)
>     (ge-reg_or_+ (slot-value self 'gecode-regexp) n)
>     (error "uninitialized or dead regular expression")))
>
> I would like to generate an html and pdf with the documentation.
> Any clues how can this be done automatically?
>
> Thanks
>
> -- 
> Mauricio Toro Bermudez
> Estudiante de Ingeniería de Sistemas
> Pontificia Universidad Javeriana, Colombia
>
> Stagiare à l'Ircam
> 1, place Igor-Stravinsky 75004 Paris,
> France de 2008 à 2009

--
Gary Warren King, metabang.com
Cell: (413) 559 8738
Fax: (206) 338-4052
gwkkwg on Skype * garethsan on AIM

RE: Generating documentation for Lisp

---

From: owner-lisp-hug@lispworks.com [mailto:owner-lisp-hug@lispworks.com] On Behalf Of Mauricio Toro
Sent: Tuesday, July 22, 2008 5:31 PM
To: lisp-hug@lispworks.com
Subject: Generating documentation for Lisp

Hello,

I have some methods and classes defined this way:

(defmethod g-or+ ((self ge-regexp) n)

  "OR regula expr self with integer n one or more times"

  (if (exists self)

    (ge-reg_or_+ (slot-value self 'gecode-regexp) n)

    (error "uninitialized or dead regular expression")))

I would like to generate an html and pdf with the documentation.

Any clues how can this be done automatically?

Thanks

--
Mauricio Toro Bermudez
Estudiante de Ingeniería de Sistemas
Pontificia Universidad Javeriana, Colombia

Stagiare à l'Ircam
1, place Igor-Stravinsky 75004 Paris,
France de 2008 à 2009