Is a Javadoc API supposed to be imperative or not?

Andrew Haley aph at redhat.com
Wed Mar 11 14:19:03 UTC 2015


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?

Thanks,
Andrew.



More information about the core-libs-dev mailing list