RFR: 8337344: Typo at RasterPrinterJob.isCancelled
Alexey Ivanov
aivanov at openjdk.org
Tue Jul 30 13:13:31 UTC 2024
On Tue, 30 Jul 2024 03:05:22 GMT, Prasanta Sadhukhan <psadhukhan at openjdk.org> wrote:
>> src/java.desktop/share/classes/sun/print/RasterPrinterJob.java line 2481:
>>
>>> 2479: * has cancelled the printjob and will
>>> 2480: * be cancelled at the next opportunity. false is
>>> 2481: * returned otherwise.
>>
>> Does it add anything to the description of [`PrinterJob.isCancelled`](https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/java/awt/print/PrinterJob.html#isCancelled())?
>>
>> <q cite="https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/java/awt/print/PrinterJob.html#isCancelled()">Returns `true` if a print job is in progress, but is going to be cancelled at the next opportunity; otherwise returns `false`.</q>
>>
>> The description here repeats the same but in other words. I propose removing this javadoc comment altogether.
>
> I guess we can remove or we can put @inheritDoc..
> @prrace Any preference from you?
If it were a public class, I'd go for `{@inheritDoc}`; since it's not a public, I'm for removing it.
Whatever you choose, updating the bug title is a good thing.
-------------
PR Review Comment: https://git.openjdk.org/jdk/pull/20375#discussion_r1696939227
More information about the client-libs-dev
mailing list