Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [e4-dev] Question about @Deprecate

I agree, it is mostly redundant, but there are two reasons why we should add it:

1) Our Javadoc guide lines (http://wiki.eclipse.org/Javadoc) refer to Oracle's Javadoc guidelines, which recommend this. Yes, we could add yet another exception, but not worth it here.
2) It allows to find all deprecated members in a JAR that has no source attached.

Dani


From:        Markus Keller/Zurich/IBM@IBMCH
To:        E4 Project developer mailing list <e4-dev@xxxxxxxxxxx>
Date:        15.07.2013 22:36
Subject:        Re: [e4-dev] Question about @Deprecate
Sent by:        e4-dev-bounces@xxxxxxxxxxx




I see no point in adding @Deprecated and I would not use it.

Currently, it just clutters code, since the @deprecated Javadoc tag is still required (must explain the transition path to the replacement API or why there is no replacement). If Java compilers ever stop processing @deprecated, then the "Add missing '@Deprecated' annotations" clean up can be used.


Here's a Stackoverflow entry:
http://stackoverflow.com/questions/5039723/should-i-use-javadoc-deprecation-or-the-annotation-in-java
Nobody found a use case that would require @Deprecated right now.


Markus




From:        
Daniel Megert/Zurich/IBM@IBMCH
To:        
E4 Project developer mailing list <e4-dev@xxxxxxxxxxx>
Date:        
2013-07-15 13:51
Subject:        
Re: [e4-dev] Question about @Deprecate
Sent by:        
e4-dev-bounces@xxxxxxxxxxx




>
For the plug-ins that have moved to Java 1.5 would it add value to add the @Deprecated annotation?  

Yes, adding a @Deprecated annotation is the way to go in 1.5 an beyond. For details see

http://docs.oracle.com/javase/1.5.0/docs/guide/javadoc/deprecation/deprecation.html

Dani



From:        
Lars Vogel <lars.vogel@xxxxxxxxx>
To:        
E4 Project developer mailing list <e4-dev@xxxxxxxxxxx>
Date:        
12.07.2013 12:18
Subject:        
[e4-dev] Question about @Deprecate
Sent by:        
e4-dev-bounces@xxxxxxxxxxx




Hi,

I see in sometimes in the Eclipse platform source code that only the @deprecated Javadoc annotation is used.  

For the plug-ins that have moved to Java 1.5 would it add value to add the @Deprecated annotation?  

Best regards, Lars



_______________________________________________
e4-dev mailing list
e4-dev@xxxxxxxxxxx

https://dev.eclipse.org/mailman/listinfo/e4-dev
_______________________________________________
e4-dev mailing list
e4-dev@xxxxxxxxxxx

https://dev.eclipse.org/mailman/listinfo/e4-dev
_______________________________________________
e4-dev mailing list
e4-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/e4-dev


Back to the top