[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: NYIException

From: Ricky Clarkson
Subject: Re: NYIException
Date: 27 Sep 2003 17:57:36 +0100
User-agent: Mutt/1.5.4i


I believe the functionality of @unimplemented would be adequately
replaced by @since and throw new UnsupportedOperationException.

To find out what methods of, e.g., JDK1.2 are unsupported, you can
simply search for methods that have @since 1.2 and throw
UnsupportedOperationException from their body.

I don't see how @unimplemented or NotYetImplementedException would give
extra information.

The reason for not implementing the method could be explained in normal
Javadoc comments, and this avoids generated documentation missing out
this information, as would happen if one ran Sun Javadoc over a method
with an @unimplemented tag, as far as I know.



On Fri, Sep 26, 2003 at 02:38:30PM +0200, Sascha Brawer wrote:
> What would you say about defining a special Javadoc tag, such as the
> following?
> /**
>  * @unimplemented 1.4 Here comes some explanation.
>  */
> [class|method|field]
> It would not be too difficult to write a special doclet for the purpose
> of generating a document that summarizes the implementation status. Plus,
> it would be possible to document what exactly is not implemented, the
> reason, etc. The explanation text would also go into the generated
> documentation files.
> -- Sascha
> Sascha Brawer, address@hidden, 
> _______________________________________________
> Classpath mailing list
> address@hidden

reply via email to

[Prev in Thread] Current Thread [Next in Thread]