Uploaded image for project: 'JBoss Enterprise Application Platform'
  1. JBoss Enterprise Application Platform
  2. JBEAP-5139

Improve readability of multiline comments in QS pom files

    XMLWordPrintable

Details

    • Bug
    • Resolution: Done
    • Optional
    • 7.1.0.DR2
    • 7.0.0.GA
    • Quickstarts
    • None

    Description

      Some of the comments in pom.xml files are split to several smaller comments, which decreases the readability. For example (from helloworld-mbean QS, but can be found in other QS, too):

              <!-- Explicitly declaring the source encoding eliminates the following
                   message: -->
              <!-- [WARNING] Using platform encoding (UTF-8 actually) to copy filtered
                   resources, i.e. build is platform dependent! -->
              <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
      

      I would suggest to change it to:

              <!-- Explicitly declaring the source encoding eliminates the following
                   message:
                   [WARNING] Using platform encoding (UTF-8 actually) to copy filtered
                   resources, i.e. build is platform dependent! -->
              <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
      

      This way it is more obvious that the 2 comments belong together and both relate to the <project.build.sourceEncoding> property declaration.

      There are other similar examples in the pom.xml files, too, e.g.:

                  <!-- An optional Arquillian testing profile that executes tests in your JBoss EAP instance -->
                  <!-- This profile will start a new JBoss EAP instance, and execute the test, shutting it down when done -->
                  <!-- Run with: mvn clean test -Parq-wildfly-managed -->
                  <id>arq-wildfly-managed</id>
      

      Attachments

        Activity

          People

            sgilda_jira Sande Gilda (Inactive)
            nziakova@redhat.com Nikoleta Ziakova (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: