Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-8329299

@since checker for generated Javadoc

XMLWordPrintable

    • Icon: Enhancement Enhancement
    • Resolution: Unresolved
    • Icon: P4 P4
    • None
    • None
    • tools

      The current "Since Checker" checks @since tags in source files.

      The sequel would be to check Since: info in the generated HTML files, which would check the information presented to the end reader, and would be a check on both the tags and the processing of those tags by the standard doclet.

      To make this much easier than it may sound, there is a class in APIDiff called APIReader which reads API files generated by any version of javadoc after 10 or so, and for any page, it provides the contents of the main description, and the description of any members (i.e. for class or interface files.) Thus for any declared item, it is possible to get the fragment of HTMNL generated from its doc comment, and within that, it would be relatively easy to regex-parse it to find the Since: info. All other processing such as determining when the item was introduced would be as now, in the current Since Checker.

            mtrudeau Michel Trudeau
            mtrudeau Michel Trudeau
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated: