Naive question about documenting classes

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

Naive question about documenting classes

stefano-franchi
I am sure this is a naive question that must have been answered here
and perhaps is addressed in the documentation, but my digging efforts
in both places have turned out nothing.

Question:

Is it possible to print out a formatted representation of a class,
including methods, class methods, and comments?

The file out method produces a xml representation, but I am not really
sure what to do with it---is there any simple/automatic way to pretty
print the XML representation?

Thanks for the help.

Stefano



__________________________________________________
Stefano Franchi
Department of Philosophy                  Ph:  (64)  9 373-7599 x83940
University Of Auckland Fax: (64) 9 373-8768
Private Bag 92019 [hidden email]
Auckland
New Zealand

Reply | Threaded
Open this post in threaded view
|

Re: Naive question about documenting classes

jarober
There are two tools that can drop out a nicer representation:

Load "All Advanced Tools" and use the class reporter

or

Using ADvance (load the package from the parcel manager), you can
produce HTML class reports


At 11:33 AM 3/11/2007, you wrote:

>I am sure this is a naive question that must have been answered here
>and perhaps is addressed in the documentation, but my digging
>efforts in both places have turned out nothing.
>
>Question:
>
>Is it possible to print out a formatted representation of a class,
>including methods, class methods, and comments?
>
>The file out method produces a xml representation, but I am not
>really sure what to do with it---is there any simple/automatic way
>to pretty print the XML representation?
>
>Thanks for the help.
>
>Stefano
>
>
>
>__________________________________________________
>Stefano Franchi
>Department of Philosophy                  Ph:  (64)  9 373-7599 x83940
>University Of Auckland                  Fax: (64) 9 373-8768
>Private Bag 92019                               [hidden email]
>Auckland
>New Zealand

<Talk Small and Carry a Big Class Library>
James Robertson, Product Manager, Cincom Smalltalk
http://www.cincomsmalltalk.com/blog/blogView

Reply | Threaded
Open this post in threaded view
|

Re: Naive question about documenting classes

Boris Popov, DeepCove Labs (SNN)
In reply to this post by stefano-franchi
Re: Naive question about documenting classes

Heh, here's an idea, someone should make a stylesheet for a fileout format. Not so much for documentation, but to make it a little more readable using a regular browser.

Cheers!

-Boris
(Sent from a BlackBerry)

----- Original Message -----
From: James Robertson <[hidden email]>
To: [hidden email] <[hidden email]>
Sent: Sun Mar 11 08:47:04 2007
Subject: Re: Naive question about documenting classes

There are two tools that can drop out a nicer representation:

Load "All Advanced Tools" and use the class reporter

or

Using ADvance (load the package from the parcel manager), you can
produce HTML class reports


At 11:33 AM 3/11/2007, you wrote:
>I am sure this is a naive question that must have been answered here
>and perhaps is addressed in the documentation, but my digging
>efforts in both places have turned out nothing.
>
>Question:
>
>Is it possible to print out a formatted representation of a class,
>including methods, class methods, and comments?
>
>The file out method produces a xml representation, but I am not
>really sure what to do with it---is there any simple/automatic way
>to pretty print the XML representation?
>
>Thanks for the help.
>
>Stefano
>
>
>
>__________________________________________________
>Stefano Franchi
>Department of Philosophy                  Ph:  (64)  9 373-7599 x83940
>University Of Auckland                  Fax: (64) 9 373-8768
>Private Bag 92019                               [hidden email]
>Auckland
>New Zealand

<Talk Small and Carry a Big Class Library>
James Robertson, Product Manager, Cincom Smalltalk
http://www.cincomsmalltalk.com/blog/blogView

Reply | Threaded
Open this post in threaded view
|

Re: Naive question about documenting classes

Holger Kleinsorgen-4
In reply to this post by stefano-franchi
Stefano Franchi wrote:
> I am sure this is a naive question that must have been answered here and
> perhaps is addressed in the documentation, but my digging efforts in
> both places have turned out nothing.

coincidently (actually, because I didn't find anything that pleased me,
too) I published a rather simple (and yet unfinished) package named
"HkMiniDoc" to the public repository (if you don't have access to it see
http://www.cincomsmalltalk.com/CincomSmalltalkWiki/PostgreSQL+Access+Page )

hth, Holger

Reply | Threaded
Open this post in threaded view
|

Re: Naive question about documenting classes

Reinout Heeck
In reply to this post by stefano-franchi

And for already filed-out code VW's file browser has a nice 'formated  
code' tab from which you can copy-n-paste.

R
-

Reply | Threaded
Open this post in threaded view
|

Re: Naive question about documenting classes

Travis Griggs-3
In reply to this post by stefano-franchi
On Mar 11, 2007, at 8:33, Stefano Franchi wrote:

I am sure this is a naive question that must have been answered here and perhaps is addressed in the documentation, but my digging efforts in both places have turned out nothing.

Question:

Is it possible to print out a formatted representation of a class, including methods, class methods, and comments?

The file out method produces a xml representation, but I am not really sure what to do with it---is there any simple/automatic way to pretty print the XML representation?

Thanks for the help.

Class Reporter. Load the "All Advanced Tools" parcel. And a Class Reports menu will appear in the launcher (under Tools I think). The UI for it is a bit dated. But it does an adequate job. Modernizing these tools is on the docket for this coming year.

--
Travis Griggs
Objologist
"It's [a spec] _the_ single worst way to write software, because it by definition means that the software was written to match theory, not reality" - Linus Torvalds


Reply | Threaded
Open this post in threaded view
|

Re: Naive question about documenting classes

stefano-franchi
Thanks to everyone for the prompt and helpful replies. A combination of
Class reporter and the functionalities offered by the file browser does
fulfill my needs.
I am still trying to figure out how to produce a ps or pdf file from
the class reporter, but I'll figure that out from the documentation
sooner or later


Cheers,


Stefano


On 11 Mar, 2007, at 4:19 PM, Travis Griggs wrote:

> On Mar 11, 2007, at 8:33, Stefano Franchi wrote:
>
>> I am sure this is a naive question that must have been answered here
>> and perhaps is addressed in the documentation, but my digging efforts
>> in both places have turned out nothing.
>>
>> Question:
>>
>> Is it possible to print out a formatted representation of a class,
>> including methods, class methods, and comments?
>>
>> The file out method produces a xml representation, but I am not
>> really sure what to do with it---is there any simple/automatic way to
>> pretty print the XML representation?
>>
>> Thanks for the help.
> Class Reporter. Load the "All Advanced Tools" parcel. And a Class
> Reports menu will appear in the launcher (under Tools I think). The UI
> for it is a bit dated. But it does an adequate job. Modernizing these
> tools is on the docket for this coming year.
>
> --
> Travis Griggs
> Objologist
> "It's [a spec] _the_ single worst way to write software, because it by
> definition means that the software was written to match theory, not
> reality" - Linus Torvalds
>
>
>
>
__________________________________________________
Stefano Franchi
Department of Philosophy                  Ph:  (64)  9 373-7599 x83940
University Of Auckland Fax: (64) 9 373-8768
Private Bag 92019 [hidden email]
Auckland
New Zealand

Reply | Threaded
Open this post in threaded view
|

Re: Naive question about documenting classes

Mark Pirogovsky-3
Stefano,

PS files are easy -- THe support for the PS level 3 is built in into the
VW.  Try to step through "Document doTest1" and stop at the method
PostScriptFile>> print.  As an intermediate step the PS  file (named
"PrintJob")is being created.

--Mark

Stefano Franchi wrote:

> Thanks to everyone for the prompt and helpful replies. A combination of
> Class reporter and the functionalities offered by the file browser does
> fulfill my needs.
> I am still trying to figure out how to produce a ps or pdf file from the
> class reporter, but I'll figure that out from the documentation sooner
> or later
>
>
> Cheers,
>
>
> Stefano
>
>
> On 11 Mar, 2007, at 4:19 PM, Travis Griggs wrote:
>
>> On Mar 11, 2007, at 8:33, Stefano Franchi wrote:
>>
>>> I am sure this is a naive question that must have been answered here
>>> and perhaps is addressed in the documentation, but my digging efforts
>>> in both places have turned out nothing.
>>>
>>> Question:
>>>
>>> Is it possible to print out a formatted representation of a class,
>>> including methods, class methods, and comments?
>>>
>>> The file out method produces a xml representation, but I am not
>>> really sure what to do with it---is there any simple/automatic way to
>>> pretty print the XML representation?
>>>
>>> Thanks for the help.
>>
>> Class Reporter. Load the "All Advanced Tools" parcel. And a Class
>> Reports menu will appear in the launcher (under Tools I think). The UI
>> for it is a bit dated. But it does an adequate job. Modernizing these
>> tools is on the docket for this coming year.
>>
>> --
>> Travis Griggs
>> Objologist
>> "It's [a spec] _the_ single worst way to write software, because it by
>> definition means that the software was written to match theory, not
>> reality" - Linus Torvalds
>>
>>
>>
>>
> __________________________________________________
> Stefano Franchi
> Department of Philosophy                  Ph:  (64)  9 373-7599 x83940
> University Of Auckland            Fax: (64) 9 373-8768
> Private Bag 92019                [hidden email]
> Auckland
> New Zealand          
>
>
>