You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@groovy.apache.org by "Christopher Wright (JIRA)" <ji...@apache.org> on 2019/01/30 16:21:00 UTC
[jira] [Updated] (GROOVY-8976) Groovydoc interprets /** in string
method comment
[ https://issues.apache.org/jira/browse/GROOVY-8976?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Christopher Wright updated GROOVY-8976:
---------------------------------------
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#L451]
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.
was:
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#L451]
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.
> Groovydoc interprets /** in string method comment
> -------------------------------------------------
>
> Key: GROOVY-8976
> URL: https://issues.apache.org/jira/browse/GROOVY-8976
> Project: Groovy
> Issue Type: Bug
> Components: GroovyDoc
> Affects Versions: 2.5.5
> Reporter: Christopher Wright
> Priority: Minor
>
> 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#L451]
>
> 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.
>
>
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)