Is a Javadoc API supposed to be imperative or not?

Wed Mar 11 14:23:09 UTC 2015

On Wed, Mar 11, 2015 at 7:19 AM, Andrew Haley <aph at redhat.com> wrote:

> Javadoc API seems to be descriptive:
>
> "Returns a string ...
> "Wakes up a single thread ...
> "Creates and returns ...
>
> But sometimes it's imperative:
>
> "Block current thread, returning when...
> "Report the scale...
> "Define a class...
>
> Which is right?
>
>
The former!

(Switch to imperative voice for implementation comments.)