<i18n dev> RFR: 8278254: Cleanup doclint warnings in java.desktop module [v4]

Alexey Ivanov aivanov at openjdk.java.net
Mon Jan 24 10:54:18 UTC 2022


On Mon, 24 Jan 2022 06:00:02 GMT, Prasanta Sadhukhan <psadhukhan at openjdk.org> wrote:

>> src/java.desktop/share/classes/javax/swing/filechooser/FileSystemView.java line 353:
>> 
>>> 351:      * File(parent, fileName)</code> except when the parent and child are both
>>> 352:      * special folders, in which case the <code>File</code> is a wrapper containing
>>> 353:      * a <code>ShellFolder</code> object.
>> 
>> Is a "ShellFolder" part of the public API? If not should we mention it in the spec?
>
> It is already mentioned in getSystemDisplayName, getSystemTypeDescription, getSystemIcon, isRoot. Anyways, I have removed the linkage for the new addition as it will not be able to resolve.

If `ShellFolder` remains mentioned, I'd rather use `<code>ShellFolder</code>` as it was done originally.

I guess Sergey challenged the fact of referencing `ShellFolder`. The fact that it could be `ShellFolder` rather than `File` is an implementation detail. Can we drop that from the spec?

On the other hand, `ShellFolder` class, even though it's not a public API, is mentioned in quite a few methods in `FileSystemView`.

I don't have a strong opinion here. Perhaps, we should scrap all the references to `ShellFolder`.

-------------

PR: https://git.openjdk.java.net/jdk/pull/7004


More information about the i18n-dev mailing list