GoogleCodeArchive / piccolo2d

Automatically exported from code.google.com/p/piccolo2d
0 stars 0 forks source link

Rephrase javadoc package comments #41

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago
Currently the javadoc package comments come in a style

"This package supports Piccolo activities."

I'd like to rephrase them to a style

"Activities"

as the omitted text transports no information.

In other words: Change the verb-ish style to a noun-ish.

P.S.: As soon as this issue is marked accepted by e.g. Stephen or Michael, 
I'll change the comments and commit them to the trunk.

Original issue reported on code.google.com by mr.rohrm...@googlemail.com on 11 Jul 2008 at 8:25

GoogleCodeExporter commented 9 years ago
I agree the phrasing of the package-level javadocs is too indirect.  I would 
suggest
this be pushed off to 1.3 as I forsee a lot of other javadoc improvements being 
made
at that point.

Original comment by heue...@gmail.com on 15 Jul 2008 at 4:27

GoogleCodeExporter commented 9 years ago
Ok, let's get 1.2.1 out of the door and put this (and other javadoc issues as 
you 
mentioned) into 1.3.

I consider the issue as accepted and will start working on it after 1.2.1 is 
finished.

Original comment by mr.rohrm...@googlemail.com on 17 Jul 2008 at 1:38

GoogleCodeExporter commented 9 years ago

Original comment by mr0...@mro.name on 29 Jul 2008 at 1:39

GoogleCodeExporter commented 9 years ago

Original comment by mr0...@mro.name on 29 Jul 2008 at 1:40

GoogleCodeExporter commented 9 years ago
I'm all for this, if you can get it in quickly.

Original comment by heue...@gmail.com on 21 Oct 2009 at 2:24

GoogleCodeExporter commented 9 years ago
I'm not for this since clicking on a package in the javadocs and expecting 
helpful
easy to read documentation would hardly be met by ariving at a single word 
"Activities"

Original comment by allain.lalonde on 21 Oct 2009 at 9:12

GoogleCodeExporter commented 9 years ago

Original comment by mr0...@mro.name on 25 Oct 2009 at 6:50

GoogleCodeExporter commented 9 years ago

Original comment by allain.lalonde on 30 Oct 2009 at 4:13