package documentation viewer
Locked
 
|
Hi, for fun and *for me*, I've made a small Seaside app to quickly browse all documentation in a Pharo image. It's package oriented, all classes and selectors comment on a single page, so I can use search and print functions of my web browser.
Someone might have a use of it. It's here: http://www.squeaksource.com/SimpleWebDoc.html
Laurent _______________________________________________ Pharo-project mailing list [hidden email] http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-project |
Re: package documentation viewer
|
|
Looks good. Maybe this could be part of the Pharo website no ?
Alexandre On 9 Dec 2009, at 07:49, laurent laffont wrote: > Hi, > > for fun and *for me*, I've made a small Seaside app to quickly > browse all documentation in a Pharo image. > It's package oriented, all classes and selectors comment on a > single page, so I can use search and print functions of my web > browser. > > Someone might have a use of it. It's here: http://www.squeaksource.com/SimpleWebDoc.html > Screenshots: http://picasaweb.google.fr/laurent.laffont/Simplewebdoc > > Laurent > > _______________________________________________ > Pharo-project mailing list > [hidden email] > http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-project -- _,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;: Alexandre Bergel http://www.bergel.eu ^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;. _______________________________________________ Pharo-project mailing list [hidden email] http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-project |
|
|
I also vote for having it running at Pharo website.
However it gives another opportunity to my canvassing: it is imperative that the comments written (class and methods) be accurate and uptodate!! -- Cesar Rabak Em 09/12/2009 11:06, Alexandre Bergel < [hidden email] > escreveu: Looks good. Maybe this could be part of the Pharo website no ? Alexandre On 9 Dec 2009, at 07:49, laurent laffont wrote: > Hi, > > for fun and *for me*, I've made a small Seaside app to quickly > browse all documentation in a Pharo image. > It's package oriented, all classes and selectors comment on a > single page, so I can use search and print functions of my web > browser. > > Someone might have a use of it. It's here: http://www.squeaksource.com/SimpleWebDoc.html > Screenshots: http://picasaweb.google.fr/laurent.laffont/Simplewebdoc > > Laurent > > _______________________________________________ > Pharo-project mailing list > [hidden email] > http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-project -- _,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;: Alexandre Bergel http://www.bergel.eu ^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;. _______________________________________________ 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 |
Re: package documentation viewer
|
|
> However it gives another opportunity to my canvassing: it is
> imperative that the comments written (class and methods) be accurate > and uptodate!! Indeed Alexandre -- _,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;: Alexandre Bergel http://www.bergel.eu ^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;. _______________________________________________ Pharo-project mailing list [hidden email] http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-project |
Re: package documentation viewer
|
|
In reply to this post by csrabak
On 9 déc. 2009, at 19:11, [hidden email] wrote: > I also vote for having it running at Pharo website. > > However it gives another opportunity to my canvassing: it is imperative that the comments written (class and methods) be accurate and uptodate!! Can someone quickly run some query to see how bad it is? That is, how many classes without comment or with the generic template? > > -- > Cesar Rabak > > > Em 09/12/2009 11:06, Alexandre Bergel < [hidden email] > escreveu: > > > Looks good. Maybe this could be part of the Pharo website no ? > > Alexandre > > > On 9 Dec 2009, at 07:49, laurent laffont wrote: > >> Hi, >> >> for fun and *for me*, I've made a small Seaside app to quickly >> browse all documentation in a Pharo image. >> It's package oriented, all classes and selectors comment on a >> single page, so I can use search and print functions of my web >> browser. >> >> Someone might have a use of it. It's here: http://www.squeaksource.com/SimpleWebDoc.html >> Screenshots: http://picasaweb.google.fr/laurent.laffont/Simplewebdoc >> >> Laurent >> >> _______________________________________________ >> Pharo-project mailing list >> [hidden email] >> http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-project > > -- > _,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;: > Alexandre Bergel http://www.bergel.eu > ^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;. > > > > > > > _______________________________________________ > 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 -- Simon _______________________________________________ Pharo-project mailing list [hidden email] http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-project |
|
|
I already started working on this, give me the weekend and I'll post results.
If they are worth, I'll put an issue for this. -- Cesar Rabak Em 09/12/2009 21:30, Simon Denier < [hidden email] > escreveu: On 9 déc. 2009, at 19:11, [hidden email] wrote: > I also vote for having it running at Pharo website. > > However it gives another opportunity to my canvassing: it is imperative that the comments written (class and methods) be accurate and uptodate!! Can someone quickly run some query to see how bad it is? That is, how many classes without comment or with the generic template? > > -- > Cesar Rabak > > > Em 09/12/2009 11:06, Alexandre Bergel < [hidden email] > escreveu: > > > Looks good. Maybe this could be part of the Pharo website no ? > > Alexandre > > > On 9 Dec 2009, at 07:49, laurent laffont wrote: > >> Hi, >> >> for fun and *for me*, I've made a small Seaside app to quickly >> browse all documentation in a Pharo image. >> It's package oriented, all classes and selectors comment on a >> single page, so I can use search and print functions of my web >> browser. >> >> Someone might have a use of it. It's here: http://www.squeaksource.com/SimpleWebDoc.html >> Screenshots: http://picasaweb.google.fr/laurent.laffont/Simplewebdoc >> >> Laurent >> >> _______________________________________________ >> Pharo-project mailing list >> [hidden email] >> http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-project > > -- > _,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;: > Alexandre Bergel http://www.bergel.eu > ^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;. > > > > > > > _______________________________________________ > 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 -- Simon _______________________________________________ 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 |
Re: package documentation viewer
|
|
Sounds good
Alexandre On 10 Dec 2009, at 15:21, [hidden email] wrote: > I already started working on this, give me the weekend and I'll post > results. > If they are worth, I'll put an issue for this. > > -- > Cesar Rabak > > > Em 09/12/2009 21:30, Simon Denier < [hidden email] > escreveu: > > > > On 9 déc. 2009, at 19:11, [hidden email] wrote: > >> I also vote for having it running at Pharo website. >> >> However it gives another opportunity to my canvassing: it is >> imperative that the comments written (class and methods) be >> accurate and uptodate!! > > > Can someone quickly run some query to see how bad it is? That is, > how many classes without comment or with the generic template? > > >> >> -- >> Cesar Rabak >> >> >> Em 09/12/2009 11:06, Alexandre Bergel < [hidden email] > >> escreveu: >> >> >> Looks good. Maybe this could be part of the Pharo website no ? >> >> Alexandre >> >> >> On 9 Dec 2009, at 07:49, laurent laffont wrote: >> >>> Hi, >>> >>> for fun and *for me*, I've made a small Seaside app to quickly >>> browse all documentation in a Pharo image. >>> It's package oriented, all classes and selectors comment on a >>> single page, so I can use search and print functions of my web >>> browser. >>> >>> Someone might have a use of it. It's here: http://www.squeaksource.com/SimpleWebDoc.html >>> Screenshots: http://picasaweb.google.fr/laurent.laffont/Simplewebdoc >>> >>> Laurent >>> >>> _______________________________________________ >>> Pharo-project mailing list >>> [hidden email] >>> http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-project >> >> -- >> _,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;: >> Alexandre Bergel http://www.bergel.eu >> ^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;. >> >> >> >> >> >> >> _______________________________________________ >> 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 > > -- > Simon > > > > > _______________________________________________ > 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 -- _,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;: Alexandre Bergel http://www.bergel.eu ^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;. _______________________________________________ Pharo-project mailing list [hidden email] http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-project |
|
|
In reply to this post by Simon Denier-3
Em 09/12/2009 21:30, Simon Denier <[hidden email]> escreveu:
> On 9 déc. 2009, at 19:11, [hidden email] wrote: > > I also vote for having it running at Pharo website. > > However it gives another opportunity to my canvassing: it is > > imperative that the comments written (class and methods) be > > accurate and uptodate!! > > Can someone quickly run some query to see how bad it is? That is, > how many classes without comment or with the generic template? > I ran the following script in the Workspace: nocomments := Smalltalk allClasses select: [:c | c comment string prefixMatchesRegex: '. [A-z]+ is x+\.$']. The results in the images I have are: +--------+------+------+ |Image |update|result| +--------+------+------+ |1.0-dev | 10502| 954| +--------+------+------+ |1.1-core| 11097| 613| +--------+------+------+ | 1.1-dev| 11097| 967| +--------+------+------+ Doing the same exercise with a bloc [:c| c comment string isEmpty] returns no class. Is there another search string or way to detect other empty comments? -- Cesar Rabak _______________________________________________ Pharo-project mailing list [hidden email] http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-project |
Re: package documentation viewer
|
|
> Is there another search string or way to detect other empty comments?
Smalltalk allClasses select: [ :class | class organization classComment isEmpty ] Lukas -- Lukas Renggli http://www.lukas-renggli.ch _______________________________________________ Pharo-project mailing list [hidden email] http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-project |
|
|
Em 13/12/2009 19:00, Lukas Renggli <[hidden email]> escreveu:
> > Is there another search string or way to detect other empty comments? > Smalltalk allClasses select: [ :class | class organization > classComment isEmpty ] Lukas, Your way is clever (I didn't know ClassOrganizer until this exchange)! OTOH, it rises all the numbers: +--------+-------+-------+ | Image| update|result | | | | | +--------+-------+-------+ |1.0-dev | 10502 | 1831| +--------+-------+-------+ |1.1-core| 11098 | 703| +--------+-------+-------+ | 1.1-dev| 11098 | 1795| +--------+-------+-------+ I think I'll open an issue in the tracker. -- Cesar Rabak _______________________________________________ Pharo-project mailing list [hidden email] http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-project |
Re: package documentation viewer
|
|
In reply to this post by laurent laffont
Hi,
I've added generation of inheritance diagram using yuml.me, funny. See:
Laurent
On Wed, Dec 9, 2009 at 11:49 AM, laurent laffont <[hidden email]> wrote:
_______________________________________________ Pharo-project mailing list [hidden email] http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-project |
«
Return to Pharo Smalltalk Developers
|
1 view|%1 views
| Free forum by Nabble | Edit this page |