taverna-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Stian Soiland-Reyes (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (TAVERNA-897) Remove @author tags?
Date Mon, 15 Feb 2016 09:54:18 GMT

    [ https://issues.apache.org/jira/browse/TAVERNA-897?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15147140#comment-15147140
] 

Stian Soiland-Reyes commented on TAVERNA-897:
---------------------------------------------

{code}
stain@biggie:~/src/taverna$ find . -type f -name '*java' | grep src | xargs grep '@author'
| cut -d '@' -f 2 | sort | wc -l
2367
{code}

{code}
stain@biggie:~/src/taverna$ find . -type f -name '*java' | grep src | xargs grep '@author'
| cut -d '@' -f 2 | sort | uniq
author <a href="mailto:jason
author <A HREF="mailto:martin.senger
author <a href="mailto:Scott.Stark
author alanrw
author alanrw
author Alan R Williams
author Alan Williamns
author Alan Williams
author Alexandra Nenadic
author Alex Nenadic
author Alex Nenadic
author alson
author anonymous from T1
author Asger Askov-Bleking
author Christian Brenninkmeijer
author Dave Miller<br/>
author David Withers
author David Withers
author dkf
author Dmitry Repchevsky
author Donal Fellows
author Donal Fellows.
author Donal Fellows
author Donal Fellows (based on work by Daniel Hagen)
author Donal Fellows (et al)
author Donal K. Fellows
author Eddie An action that for BioMobyProcessors
author Eddie Kawas
author Eddie Kawas, The BioMoby Project
author Edward Kawas
author Edward Kawas
author Emmanuel Tagarira
author Emmanuel Tagarira, Alan Williams
author Emmanuel Tagarira, Sergejs Aleksejevs
author Emmanuel Tagarira, Sergejs Aleksejevs, Alan Williams
author    Francis Labrie
author Hajo Krabbenhoeft
author Hajo Nils Krabbenhoeft
author Hajo Nils Krabbenhoeft with some contribution by
author Ian Dunlop
author Ingo Wassink
author Jiten Bhagat
author Jiten Bhagat, Emmanuel Tagarira
author Jiten Bhagat, Sergejs Aleksejevs
author Jose Maria Fernandez, INB
author Kevin Glover
author Kyle Gabhart
author Larry Akah
author Mark
author Martin Senger
author Matthew Pocock
author paolo
author Paolo Missier
author Peter Li
author Philip Milne
author Philip Milne 
author rob
author Robert Camick
author Robert Hanson
author Robert Harder
author Scott Violet
author Sergejs Aleksejevs
author Sergejs Aleksejevs
author Sergejs Aleksejevs, Emmanuel Tagarira
author Sergejs Aleksejevs, Emmanuel Tagarira, Jiten Bhagat
author Sergejs Aleksejevs, Jiten Bhagat
author sowen
author stain
author Start Owen
author Steffen Moeller
author Steffen Moeller
author Stian Soiland
author Stian Soiland-Reyes
author Stian Soiland-Reyes.
author Stian Soiland-Reyes
author Stuart
author Stuart owen
author Stuart Owen
author Stuart Owen - adapted for Taverna 2
author Stuart Owen = initial port from T1 to T2
author Subhajit Dasgupta<br/>
author Tom
author Tom Oinn
author Tom OInn
author witherd5
{code}

I'm not proposing to remove @author tags from externally sourced files, e.g. 
./incubator-taverna-workbench/taverna-ui/src/main/java/org/apache/taverna/lang/ui/treetable/TreeTableModel.java


> Remove @author tags?
> --------------------
>
>                 Key: TAVERNA-897
>                 URL: https://issues.apache.org/jira/browse/TAVERNA-897
>             Project: Apache Taverna
>          Issue Type: Bug
>            Reporter: Stian Soiland-Reyes
>            Assignee: Stian Soiland-Reyes
>
> Some of our Javadoc contain @author tags - which are reflected in the HTML of the JAvadoc
- for instance
> http://taverna.incubator.apache.org/javadoc/taverna-language/org/apache/taverna/scufl2/api/package-summary.html
> http://taverna.incubator.apache.org/javadoc/taverna-osgi/org/apache/taverna/configuration/ConfigurationManager.html
> Apache NiFi's argument against Javadoc @author tags: http://mail-archives.apache.org/mod_mbox/incubator-nifi-dev/201505.mbox/%3CCAGHyZ6LcrZ1aPMUjJ%3DrJkkK19Cmveew7PmTUKuWprK_bz3jxmg%40mail.gmail.com%3E
– which I find myself agreeing with. 
> Older discussion also says Apache projects should stay away from @author tags:
> https://mail-archives.apache.org/mod_mbox/www-community/200306.mbox/%3C20030609234538.GA22335@lyra.org%3E
> A simple argument is that under ASF all of the Taverna committers are equally responsible
or attributable for all the code base - even if a particular person made a class to start
with.  
> Maintenance of @author tag is error-prone (how big a change  before you add yourself?
What about thousands of files with no @author?)
> Also there's the question of what is the purpose of the @author tag beyond attribution
(it shows up in the HTML representation), when any questions about a class should be taken
to dev@taverna - not to that person.
> The git log should provide attribution about who made a file, but sadly after various
folder/repository moves and version control system changes this is a bit tricky (you need
to use {{git log --follow}} and hope for the best). So there is an counter-argument for keeping
the @author tags - specially as coming up in TAVERNA-894 lots of the classes of taverna-osgi
and taverna-engine were initially written by David Withers and Tom Oinn, and neither joined
the Apache Taverna project. 
> What are your views?



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Mime
View raw message