RFR: JDK-8238648 Rename and simplify Utils.WeakSoftHashMap

2020-02-06 Thread Jonathan Gibbons
Please review a 1-file cleanup to rename and simplify Utils.WeakSoftHashMap. Utils.WeakSoftHashMap sounds like a general collection but is specifically an impl of Map. Furthermore, although it declares that it implements Map, it is always used explicitly via its own class name, and never as

RFR: JDK-8238646 Cleanup signature and use of CommentHelper

2020-02-06 Thread Jonathan Gibbons
Please review a moderately simply change to cleanup the use of CommentHelper.  (It's a non-goal to change the functionality of CommentHelper at this time.) CommentHelper objects are given a reference to the BaseConfiguration when they are constructed, but this is ignored. Subsequently, many m

RFR: JDK-8238506 fix obsolete comments and inconsistent exceptions in BaseTaglet

2020-02-06 Thread Jonathan Gibbons
Please review a small cleanup of internal doc comments, and nearby code, triggered by other recent review comments. The focus of the change was the obsolete references  to 'Tag' where 'Tag' was the JDK8 predecessor to using DocTree in javadoc.  The comments are updated. The other changes in th

Re: RFR: JDK-8238503 Remove unused field and accessor for docLocale from ToolOptions

2020-02-06 Thread Jonathan Gibbons
Correction: I've not yet pushed this change, and can fix that dead parameter before pushing. -- Jon On 02/06/2020 07:49 AM, Jonathan Gibbons wrote: Hannes, Good catch.  The file manager is used in preprocess, to set up the doclet, but you are correct that it is not used via the parameter.

RFR: JDK-8238437: Support separate locales for console messages and HTML content.

2020-02-06 Thread Jonathan Gibbons
Please review a change to use separate locales for messages written to the console and for content written in the generated HTML pages. Background: although the command-line help is not very informative about how the -locale option is used, the man page is clear that it is clear that the optio

Re: Tag certain test methods as being documentation

2020-02-06 Thread Jonathan Gibbons
Alain, Thank you for your interest. I'm not sure I understand completely how you use these methods, but I agree that it is important to ensure that the example code in documentation comments is valid code.   We are looking at ways to support that, using new tags in some way that refer to exte

Re: RFR: JDK-8238503 Remove unused field and accessor for docLocale from ToolOptions

2020-02-06 Thread Jonathan Gibbons
Hannes, Good catch.  The file manager is used in preprocess, to set up the doclet, but you are correct that it is not used via the parameter. I've already pushed the basic work, so I'll file a separate issue to clean this up. -- Jon On 2/6/20 7:30 AM, Hannes Wallnöfer wrote: Looks good.

Tag certain test methods as being documentation

2020-02-06 Thread Alain Désilets
One thing I learned about years of programming in Perl is that one of the best way to document the use of a class is to write a good synopsis for it: http://blogs.perl.org/users/neilb/2014/07/give-your-modules-a-good-synopsis.html As pointed out in this blog post, it's important to make sure tha

Re: RFR: JDK-8238503 Remove unused field and accessor for docLocale from ToolOptions

2020-02-06 Thread Hannes Wallnöfer
Looks good. The JavaFileManager argument in Start.preprocess is never used and could be removed. Hannes > Am 05.02.2020 um 00:54 schrieb Jonathan Gibbons : > > Please review a cleanup to remove some dead code and improve comments > for the tool options that are implemented in Start.preprocess