RFR: 8322708: Global HTML attributes are not allowed [v3]

[Jonathan Gibbons]

On Fri, 14 Jun 2024 12:12:51 GMT, Nizar Benalla <nbenalla at openjdk.org> wrote:

>> Can I please get a review for this change, that aims to add support for Global HTML tags.
>> Here is the [link](https://cr.openjdk.org/~nbenalla/javadocGlobalPR/pkg1/package-summary.html) to the generated docs.
>> Thanks in advance.
>
> Nizar Benalla has updated the pull request with a new target base due to a merge or a rebase. The incremental webrev excludes the unrelated changes brought in by the merge/rebase. The pull request contains ten additional commits since the last revision:
> 
>  - Null safety
>  - Merge branch 'master' into html-attributes
>  - remove trailing whitespace
>  - -Add a boolean attribute to the enum type
>    -Simply regex in `visitAttribute`
>    -Simplified the Test
>    -Added a negative test
>  - no longer print summary
>  - no longer print summary
>  - Add small comment
>  - Remove classpath exception
>  - Allow global variables

test/langtools/jdk/javadoc/doclet/TestGlobalHtml/pkg1/C1.java line 1:

> 1: /*

This example is way too big and/or insufficiently focused on global attributes.  As an example of this, compare the size of the input programs to the size (number) of strings given to `checkOutput` in. the previous file.

The challenge of writing good tests is to find the simplest example that causes the newly-written code to be executed.

Also, while not wrong, it's also "old-school" to write separate classes in separate files to run through `javadoc`.  You can often come up with small enough examples to fit in text blocks in the main test program.

In this case, I would suggest providing a class with a comment containing a whole bunch of simple tags each containing one or more global attributes. It doesn't have to make "sense" as a comment -- it just has to exercise code paths in the new code.

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

PR Review Comment: https://git.openjdk.org/jdk/pull/19652#discussion_r1635537304