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

Bogus warning generated for record with compact constructor

    XMLWordPrintable

Details

    • b29
    • generic
    • generic

    Backports

      Description

        A DESCRIPTION OF THE PROBLEM :
        If a record has a compact constructor, a comment for the constructors describing the parameters is required even if the parameters have already been described in the record comment.

        STEPS TO FOLLOW TO REPRODUCE THE PROBLEM :
        Simply "javadoc X.java"

        EXPECTED VERSUS ACTUAL BEHAVIOR :
        EXPECTED -
        No warnings
        ACTUAL -
        X.java:7: warning: no @param for i
            public X { }

        ---------- BEGIN SOURCE ----------
        /**
         * Comment.
         * @param i comment
         */
        public record X(int i) {
            /** Comment. */
            public X { }
        }
        ---------- END SOURCE ----------

        CUSTOMER SUBMITTED WORKAROUND :
        Move the parameter description to the comment of the constructor.

        FREQUENCY : always


        Attachments

          Issue Links

            backported by

            Backport - A issue that is required to port a Bug or Feature into another product release. This issue type is generally associated with the main Bug/Feature to represent each individual release of the port. JDK-8289415 Bogus warning generated for record with compact constructor

            • P3 - Major loss of function.
            • Resolved

            Backport - A issue that is required to port a Bug or Feature into another product release. This issue type is generally associated with the main Bug/Feature to represent each individual release of the port. JDK-8291197 Bogus warning generated for record with compact constructor

            • P3 - Major loss of function.
            • Resolved

            Backport - A issue that is required to port a Bug or Feature into another product release. This issue type is generally associated with the main Bug/Feature to represent each individual release of the port. JDK-8291354 Bogus warning generated for record with compact constructor

            • P3 - Major loss of function.
            • Resolved
            relates to

            Bug - A problem which impairs or prevents the functions of the product. JDK-8275199 Bogus warning generated for serializable records

            • P3 - Major loss of function.
            • Resolved

            Enhancement - null JDK-8309252 automatic copying of record constructor @param, similar to method overrides

            • P4 - Minor loss of function, or other problem where easy workaround is present.
            • Resolved
            links to

            Commit Commit openjdk/jdk19/a814293e

            Review Review openjdk/jdk19/70

            Activity

              People

                jjg Jonathan Gibbons
                webbuggrp Webbug Group
                Votes:
                0 Vote for this issue
                Watchers:
                5 Start watching this issue

                Dates

                  Created:
                  Updated:
                  Resolved: