Uploaded image for project: 'Hibernate ORM'
  1. HHH-12361

In the User Guide, omit constructors and equals/hashCode for brevity

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Minor
    • Resolution: Fixed
    • Affects versions: 5.3.0.CR2
    • Fix versions: 5.3.5, 5.4.0.CR1
    • Components: documentation
    • Labels:
      None
    • Suitable for new contributors:
      Yes, likely
    • Last commented by a user?:
      true
    • Sprint:

      Description

      In the User Guide, getters and setters are usually replaced by a simple comment:

      //Getters and setters are omitted for brevity
      

      The same should be done to the constructors (no-args + one other) and to field-based equals/hashCode implementations, since they are boring and distract from the main topic of each of the examples.

      To make this work a bit less tedious and the result very consistent, a program should be written that inserts the required code snippets automatically. It should be checked in with the test sources, so that it can be run in the future. This program should allow exceptions from the general omissions, which can be configured directly in the program.

        Attachments

          Activity

            People

            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: