ant-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Peter Donald <pe...@apache.org>
Subject @deprecated tag
Date Fri, 30 Nov 2001 17:26:05 GMT
Hi,

I just have a request for anyone who adds a @deprecated tag to javadocs. 
Could you please please please add a reason and a redirect. A lot of these 
tags are empty at the moment however I would much prefer something like

@deprecated Foo is deprecated as it encouraged bad practices. No replacement.
@deprecated Foo is deprecated and replaced with foo() to maintain similar 
coding standards. Use foo() instead.
@deprecated Foo should never be called by user code - ever ! It is completely 
unsupported. It is only public to facilitate testing via the FooTestCase

and so on and so forth. The reason for this is that your compiler will now 
warn you and tell you why you should not be using X and if there is a 
replacement.

-- 
Cheers,

Pete

--------------------------------
My opinions may have changed, 
but not the fact that I am right
--------------------------------

--
To unsubscribe, e-mail:   <mailto:ant-dev-unsubscribe@jakarta.apache.org>
For additional commands, e-mail: <mailto:ant-dev-help@jakarta.apache.org>


Mime
View raw message