[kepler-dev] @author tags in duplicated code.

[Christopher Brooks]

[I'm changing this from kepler-code to kepler-dev]

Hi Bertram,
I can guess what Sven was trying to do, but I certainly don't know for sure.

There are two issues: proper attribution and code duplication.

The problem is that Edward did not edit that file, and feels rather strongly that
his name should not appear on code that he has not edited.  The right thing when
basing a class on other source code is to give credit for the author using the
@author tag below.

The code duplication issue is slightly different issue.  I'm not sure what Sven's
intentions are here.  In the past, we have spent many hours cleaning up duplicate code.
It is better to see about modifying the parent classes.

There were some other classes that could be duplicates:

Log:
initial version of GUI modifications including:
   - drag and drop replacement of actors with reconecting ports and copying parameters
   - don't layout hidden ports that are not connected (helpful for COMAD)

    trunk/modules/gui-mod/src/ptolemy/vergil/actor/ActorController.java
    trunk/modules/gui-mod/src/ptolemy/vergil/basic/
    trunk/modules/gui-mod/src/ptolemy/vergil/basic/EditorDropTarget.java


Log:
moving gui modifications to their own module

    trunk/modules/sven_CPES/src/ptolemy/vergil/actor/ActorController.java


If the base classes need different extension points, then I'd gladly accept
well documented changes that following the Ptolemy style guide.

_Christopher




On 10/20/10 1:53 PM, Bertram Ludaescher wrote:
> Hi Christopher:
>
> Do you know what Sven was trying to do and what would be the correct way to proceed for him in this case?
>
> Thanks
>
> Bertram
>
> On Tue, Oct 19, 2010 at 8:22 PM, Christopher Brooks <cxh at eecs.berkeley.edu <mailto:cxh at eecs.berkeley.edu>> wrote:
>
>     Hi,
>     In general code duplication is a bad thing.
>
>     If you are going to duplicate ptolemy classes, then
>     please change the @author tags so that that
>     Edward and the others are not listed as authors.  Instead of
>     @author Steve Neuendorffer and Edward A. Lee, Elaine Cheong
>     Try:
>     @author Your Name, Based on XXX.java by Steve Neuendorffer and Edward A. Lee, Elaine Cheong
>
>     _Christopher
>
>     On 10/19/10 11:59 AM, koehler at ecoinformatics.org <mailto:koehler at ecoinformatics.org> wrote:
>
>         Author: koehler
>         Date: 2010-10-19 11:59:16 -0700 (Tue, 19 Oct 2010)
>         New Revision: 26115
>
>         Added:
>             trunk/modules/gui-mod/
>             trunk/modules/gui-mod/lib/
>             trunk/modules/gui-mod/lib/exe/
>             trunk/modules/gui-mod/resources/
>             trunk/modules/gui-mod/resources/system.properties/
>             trunk/modules/gui-mod/src/
>             trunk/modules/gui-mod/src/ptolemy/
>             trunk/modules/gui-mod/src/ptolemy/vergil/
>             trunk/modules/gui-mod/src/ptolemy/vergil/actor/
>             trunk/modules/gui-mod/src/ptolemy/vergil/actor/ActorController.java
>             trunk/modules/gui-mod/src/ptolemy/vergil/basic/
>             trunk/modules/gui-mod/src/ptolemy/vergil/basic/EditorDropTarget.java
>         Log:
>         initial version of GUI modifications including:
>            - drag and drop replacement of actors with reconecting ports and copying parameters
>            - don't layout hidden ports that are not connected (helpful for COMAD)
>
>
>         Added: trunk/modules/gui-mod/src/ptolemy/vergil/actor/ActorController.java
...
>         + * @author Steve Neuendorffer and Edward A. Lee, Elaine Cheong
>         + * @version $Id: ActorController.java 57046 2010-01-27 23:35:53Z cxh $
>         + * @since Ptolemy II 2.0
>         + * @Pt.ProposedRating Red (eal)
>         + * @Pt.AcceptedRating Red (johnr)
>         + * @see ActorInstanceController
>         + * @see ClassDefinitionController
>         +*/
>         +public abstract class ActorController extends AttributeController {
...
>     _______________________________________________
>     Kepler-cvs mailing list
>     Kepler-cvs at kepler-project.org <mailto:Kepler-cvs at kepler-project.org>
>     http://lists.nceas.ucsb.edu/kepler/mailman/listinfo/kepler-cvs
>
>

-- 
Christopher Brooks, PMP                       University of California
CHESS Executive Director                      US Mail: 337 Cory Hall
Programmer/Analyst CHESS/Ptolemy/Trust        Berkeley, CA 94720-1774
ph: 510.643.9841 fax:510.642.2718	      (Office: 545Q Cory)
home: (F-Tu) 707.665.0131 cell: 707.332.0670