documentation effort of Mondrian

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

documentation effort of Mondrian

abergel
Hi!

I recently documented the source code of Mondrian. This means adding class comments and methods comments.
Before the effort, only 14% of the methods were commented. Below a screenshot of the DocumentationBlueprint, a visualization intended to help me document. The MOShape class hierarchy is here presented.




After the effort, 24% of the methods are commented.  Here is another screen, after 3 days of work.



Here is the legend:
                        'big box = class' .
                        'edge = inheritance link' .
                        'small box = method' .
                        'small box height = number of lines of code' .
                        'small box width = number of collaborating classes' .
                        'red border = non commented' .

Comments are welcome

Cheers,
Alexandre
--
_,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:
Alexandre Bergel  http://www.bergel.eu
^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;.






_______________________________________________
Moose-dev mailing list
[hidden email]
https://www.iam.unibe.ch/mailman/listinfo/moose-dev

Before.png (19K) Download Attachment
After.png (20K) Download Attachment
Reply | Threaded
Open this post in threaded view
|

Re: documentation effort of Mondrian

Tudor Girba
Nice :)

Doru


On 29 Apr 2011, at 23:48, Alexandre Bergel wrote:

> Hi!
>
> I recently documented the source code of Mondrian. This means adding class comments and methods comments.
> Before the effort, only 14% of the methods were commented. Below a screenshot of the DocumentationBlueprint, a visualization intended to help me document. The MOShape class hierarchy is here presented.
>
> <Before.png>
>
> After the effort, 24% of the methods are commented.  Here is another screen, after 3 days of work.
> <After.png>
>
> Here is the legend:
> 'big box = class' .
> 'edge = inheritance link' .
> 'small box = method' .
> 'small box height = number of lines of code' .
> 'small box width = number of collaborating classes' .
> 'red border = non commented' .
>
> Comments are welcome
>
> Cheers,
> Alexandre
> --
> _,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:
> Alexandre Bergel  http://www.bergel.eu
> ^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;.
>
>
>
>
>
> _______________________________________________
> Moose-dev mailing list
> [hidden email]
> https://www.iam.unibe.ch/mailman/listinfo/moose-dev

--
www.tudorgirba.com

"Every successful trip needs a suitable vehicle."





_______________________________________________
Moose-dev mailing list
[hidden email]
https://www.iam.unibe.ch/mailman/listinfo/moose-dev
Reply | Threaded
Open this post in threaded view
|

Re: documentation effort of Mondrian

Stéphane Ducasse
In reply to this post by abergel
we should do the same in pharo :)

Stef

On Apr 29, 2011, at 11:48 PM, Alexandre Bergel wrote:

> Hi!
>
> I recently documented the source code of Mondrian. This means adding class comments and methods comments.
> Before the effort, only 14% of the methods were commented. Below a screenshot of the DocumentationBlueprint, a visualization intended to help me document. The MOShape class hierarchy is here presented.
>
> <Before.png>
>
> After the effort, 24% of the methods are commented.  Here is another screen, after 3 days of work.
> <After.png>
>
> Here is the legend:
> 'big box = class' .
> 'edge = inheritance link' .
> 'small box = method' .
> 'small box height = number of lines of code' .
> 'small box width = number of collaborating classes' .
> 'red border = non commented' .
>
> Comments are welcome
>
> Cheers,
> Alexandre
> --
> _,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:
> Alexandre Bergel  http://www.bergel.eu
> ^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;.
>
>
>
>
>
> _______________________________________________
> Moose-dev mailing list
> [hidden email]
> https://www.iam.unibe.ch/mailman/listinfo/moose-dev


_______________________________________________
Moose-dev mailing list
[hidden email]
https://www.iam.unibe.ch/mailman/listinfo/moose-dev