Uploaded image for project: 'Groovy'
  1. Groovy
  2. GROOVY-8976

Groovydoc interprets /** in string as groovydoc comment

    XMLWordPrintableJSON

Details

    • Bug
    • Status: Open
    • Minor
    • Resolution: Unresolved
    • 2.5.5
    • None
    • GroovyDoc
    • None

    Description

      In my groovy code, I had a statement like this:

       

      steps.archiveArtifacts allowEmptyArchive: true, artifacts: "$archiveLocation/**/*.*"
      

      I then ran groovydoc and the next method in my class file had all of the text present from the /** in the statement above to the ending groovydoc comment of the method.

       

      The groovydoc for the method in question can be seen here: https://github.com/zowe/zowe-cli-version-controller/blob/0b3138d0b1f581cdfac2556baf9261b51dd473df/docs/groovydoc/org/zowe/pipelines/nodejs/NodeJSRunner.html#L876

       

      The actual doc comment can be found here: https://github.com/zowe/zowe-cli-version-controller/blob/0b3138d0b1f581cdfac2556baf9261b51dd473df/src/org/zowe/pipelines/nodejs/NodeJSRunner.groovy#L431

       

      As a workaround, I currently have replaced the problem step to:

      steps.archiveArtifacts allowEmptyArchive: true, artifacts: "$archiveLocation/*" + "*/*.*"

      This change now allows the next method to properly be documented.

       

       

      Attachments

        Activity

          People

            Unassigned Unassigned
            AHumanFromBroadcom Christopher Wright
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated: