imho option a is acceptable Am 06.01.2018 um 05:13 schrieb Bernd Eckenfels:
Hello,Hao Zong reported some missing Details in the JavaDoc of ByteArrayOutputStream#write. While I dont think it is critical we should probably fix it, since a user asked for it. I am willing to go through the streams of [IO] and adjust them, but I Need to know how: a) Remove the JavaDoc of those overwritten API methods completely. This will inherit the JavaDoc from the official Stream classes which is in this case aproperiate and complete. This will make a good JavaDoc and shortst possible Code but the Code Looks underdocumented then. b) Like a) but Keep a non-Javadoc comment giving the existing short description and a note to the effect of not having JavaDoc. This retains the full JavaDoc doc, the source is however a bit longer with a uncommon block comment. c) Use javadoc with @{inheritDoc}. This makes it clear what is going on, however the @Throws documentation would Need to be replicated as it is not inherited. d) Expand the existing documentation. This will take most work and space in the Code Whats your Preference? I would really like to use a) in this case, is this acceptable? Gruss Bernd
--------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
