web package documentation

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
2 messages Options
Reply | Threaded
Open this post in threaded view
|

web package documentation

laurent laffont
Hi,

I've worked on SimpleWebDoc http://magaloma.seasidehosting.st 
(code here, http://www.squeaksource.com/SimpleWebDoc.html,  proof-of-concept)

Now it builds a package documentation overview by taking the first sentence of each class comment (if it has comment). For example:

So we can quickly see (I think) the composition of a package. 

Maybe we can have a similar thing with the new HelpSystem.

Laurent Laffont

_______________________________________________
Pharo-project mailing list
[hidden email]
http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-project
Reply | Threaded
Open this post in threaded view
|

Re: web package documentation

Stéphane Ducasse
I really like the idea!
Continue pushing.

Stef

On Feb 22, 2010, at 9:23 PM, laurent laffont wrote:

> Hi,
>
> I've worked on SimpleWebDoc http://magaloma.seasidehosting.st 
> (code here, http://www.squeaksource.com/SimpleWebDoc.html,  proof-of-concept)
>
> Now it builds a package documentation overview by taking the first sentence of each class comment (if it has comment). For example:
> http://magaloma.seasidehosting.st/Traits
>
> So we can quickly see (I think) the composition of a package.
>
> Maybe we can have a similar thing with the new HelpSystem.
>
> Laurent Laffont
> _______________________________________________
> Pharo-project mailing list
> [hidden email]
> http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-project


_______________________________________________
Pharo-project mailing list
[hidden email]
http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-project