[Pharo-project] package documentation viewer
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
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 Pharo-project@lists.gforge.inria.fr http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-project
-- _,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;: Alexandre Bergel http://www.bergel.eu ^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;.
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 < alexandre@bergel.eu > 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 Pharo-project@lists.gforge.inria.fr http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-project
-- _,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;: Alexandre Bergel http://www.bergel.eu ^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;. _______________________________________________ Pharo-project mailing list Pharo-project@lists.gforge.inria.fr http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-project
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 ^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;.
On 9 déc. 2009, at 19:11, csrabak@bol.com.br 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 < alexandre@bergel.eu > 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 Pharo-project@lists.gforge.inria.fr http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-project
-- _,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;: Alexandre Bergel http://www.bergel.eu ^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;.
_______________________________________________ Pharo-project mailing list Pharo-project@lists.gforge.inria.fr http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-project
_______________________________________________ Pharo-project mailing list Pharo-project@lists.gforge.inria.fr http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-project
-- Simon
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 < Simon.Denier@inria.fr > escreveu: On 9 déc. 2009, at 19:11, csrabak@bol.com.br 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 < alexandre@bergel.eu > 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 Pharo-project@lists.gforge.inria.fr http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-project
-- _,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;: Alexandre Bergel http://www.bergel.eu ^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;.
_______________________________________________ Pharo-project mailing list Pharo-project@lists.gforge.inria.fr http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-project
_______________________________________________ Pharo-project mailing list Pharo-project@lists.gforge.inria.fr http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-project
-- Simon _______________________________________________ Pharo-project mailing list Pharo-project@lists.gforge.inria.fr http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-project
Sounds good Alexandre On 10 Dec 2009, at 15:21, csrabak@bol.com.br 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 < Simon.Denier@inria.fr > escreveu:
On 9 déc. 2009, at 19:11, csrabak@bol.com.br 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 < alexandre@bergel.eu > 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 Pharo-project@lists.gforge.inria.fr http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-project
-- _,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;: Alexandre Bergel http://www.bergel.eu ^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;.
_______________________________________________ Pharo-project mailing list Pharo-project@lists.gforge.inria.fr http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-project
_______________________________________________ Pharo-project mailing list Pharo-project@lists.gforge.inria.fr http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-project
-- Simon
_______________________________________________ Pharo-project mailing list Pharo-project@lists.gforge.inria.fr http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-project
_______________________________________________ Pharo-project mailing list Pharo-project@lists.gforge.inria.fr http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-project
-- _,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;: Alexandre Bergel http://www.bergel.eu ^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;.
Em 09/12/2009 21:30, Simon Denier <Simon.Denier@inria.fr> escreveu:
On 9 déc. 2009, at 19:11, csrabak@bol.com.br 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
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
Em 13/12/2009 19:00, Lukas Renggli <renggli@gmail.com> 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
Hi, I've added generation of inheritance diagram using yuml.me, funny. See: http://picasaweb.google.com/lh/photo/TeKf6tmxL8Sf4n_15hJPRw?feat=directlink http://picasaweb.google.com/lh/photo/1KDY9tQpDY0Wqdgitv_WWA?feat=directlink Laurent On Wed, Dec 9, 2009 at 11:49 AM, laurent laffont <laurent.laffont@gmail.com>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
participants (5)
-
Alexandre Bergel -
csrabak＠bol.com.br -
laurent laffont -
Lukas Renggli -
Simon Denier