[jira] [Assigned] (GROOVY-9547) @see tags are not working properly
[ https://issues.apache.org/jira/browse/GROOVY-9547?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Paul King reassigned GROOVY-9547: - Assignee: Paul King > @see tags are not working properly > -- > > Key: GROOVY-9547 > URL: https://issues.apache.org/jira/browse/GROOVY-9547 > Project: Groovy > Issue Type: Bug > Components: GroovyDoc >Affects Versions: 3.0.3 >Reporter: Damir Murat >Assignee: Paul King >Priority: Minor > Attachments: image-2020-05-11-00-25-12-464.png, > image-2020-05-11-00-25-58-871.png, image-2020-05-11-00-27-49-744.png > > Time Spent: 20m > Remaining Estimate: 0h > > With Groovy 3.0.3, Groovydoc does not render @see tags properly. When trying > to link on another class in the same package from the class description, the > linked class name is rendered, but the link is not created: > !image-2020-05-11-00-25-58-871.png! > Another case is when @see is used from a method description trying to link a > method in another class in the same package. In this scenario, method name is > duplicated, and the link is missing. Something like this: > !image-2020-05-11-00-27-49-744.png! > There might be other scenarios. These two are just those that I stumbled upon. -- This message was sent by Atlassian Jira (v8.3.4#803005)
[jira] [Commented] (GROOVY-9547) @see tags are not working properly
[ https://issues.apache.org/jira/browse/GROOVY-9547?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17104981#comment-17104981 ] Paul King commented on GROOVY-9547: --- It will be merged onto the 3_0_X branch too, so targeting 3.0.4. I just didn't want to merge after midnight and then head to bed in case I broke the build. Once the ticket is resolved, you will see targeted version(s). > @see tags are not working properly > -- > > Key: GROOVY-9547 > URL: https://issues.apache.org/jira/browse/GROOVY-9547 > Project: Groovy > Issue Type: Bug > Components: GroovyDoc >Affects Versions: 3.0.3 >Reporter: Damir Murat >Priority: Minor > Attachments: image-2020-05-11-00-25-12-464.png, > image-2020-05-11-00-25-58-871.png, image-2020-05-11-00-27-49-744.png > > Time Spent: 20m > Remaining Estimate: 0h > > With Groovy 3.0.3, Groovydoc does not render @see tags properly. When trying > to link on another class in the same package from the class description, the > linked class name is rendered, but the link is not created: > !image-2020-05-11-00-25-58-871.png! > Another case is when @see is used from a method description trying to link a > method in another class in the same package. In this scenario, method name is > duplicated, and the link is missing. Something like this: > !image-2020-05-11-00-27-49-744.png! > There might be other scenarios. These two are just those that I stumbled upon. -- This message was sent by Atlassian Jira (v8.3.4#803005)
[jira] [Commented] (GROOVY-9522) Throwing NPE when I use ternary operator with something special
[
https://issues.apache.org/jira/browse/GROOVY-9522?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17104985#comment-17104985
]
Daniel Sun commented on GROOVY-9522:
The following PR should be able to fix the issue:
https://github.com/apache/groovy/pull/1246
> Throwing NPE when I use ternary operator with something special
> ---
>
> Key: GROOVY-9522
> URL: https://issues.apache.org/jira/browse/GROOVY-9522
> Project: Groovy
> Issue Type: Bug
> Components: parser
>Affects Versions: 3.0.3
> Environment: Win10/MacOS
> Zulu OpenJDK 11
>Reporter: Huabin Zhang
>Priority: Critical
>
> Hi, I got NPE instead of empty string when I wrote the following snippet:
>
> {code:java}
> static String a() {
> null
> }
> static String b() {
> ''
> }
> def x = a() ? [b(), a()].join(',') : b() // NPE
> //def x = a() ? [b(), a()] : b() // OK
> //def x = a() ? ([b(), a()]).join(',') : b() // OK
> x == ''
> {code}
>
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
[jira] [Resolved] (GROOVY-9547) @see tags are not working properly
[ https://issues.apache.org/jira/browse/GROOVY-9547?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Paul King resolved GROOVY-9547. --- Fix Version/s: 3.0.4 4.0.0-alpha-1 Resolution: Fixed > @see tags are not working properly > -- > > Key: GROOVY-9547 > URL: https://issues.apache.org/jira/browse/GROOVY-9547 > Project: Groovy > Issue Type: Bug > Components: GroovyDoc >Affects Versions: 3.0.3 >Reporter: Damir Murat >Assignee: Paul King >Priority: Minor > Fix For: 4.0.0-alpha-1, 3.0.4 > > Attachments: image-2020-05-11-00-25-12-464.png, > image-2020-05-11-00-25-58-871.png, image-2020-05-11-00-27-49-744.png > > Time Spent: 20m > Remaining Estimate: 0h > > With Groovy 3.0.3, Groovydoc does not render @see tags properly. When trying > to link on another class in the same package from the class description, the > linked class name is rendered, but the link is not created: > !image-2020-05-11-00-25-58-871.png! > Another case is when @see is used from a method description trying to link a > method in another class in the same package. In this scenario, method name is > duplicated, and the link is missing. Something like this: > !image-2020-05-11-00-27-49-744.png! > There might be other scenarios. These two are just those that I stumbled upon. -- This message was sent by Atlassian Jira (v8.3.4#803005)
[jira] [Updated] (GROOVY-9540) Bump spotbugs plugin to 4.0.8
[ https://issues.apache.org/jira/browse/GROOVY-9540?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Paul King updated GROOVY-9540: -- Fix Version/s: 4.0.0-alpha-1 > Bump spotbugs plugin to 4.0.8 > - > > Key: GROOVY-9540 > URL: https://issues.apache.org/jira/browse/GROOVY-9540 > Project: Groovy > Issue Type: Dependency upgrade >Reporter: Paul King >Assignee: Paul King >Priority: Major > Fix For: 4.0.0-alpha-1, 3.0.4 > > -- This message was sent by Atlassian Jira (v8.3.4#803005)
[jira] [Commented] (GROOVY-9547) @see tags are not working properly
[ https://issues.apache.org/jira/browse/GROOVY-9547?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17105073#comment-17105073 ] Paul King commented on GROOVY-9547: --- Merged. Thanks for spotting the issue and thanks to [~vmj] for the PR. > @see tags are not working properly > -- > > Key: GROOVY-9547 > URL: https://issues.apache.org/jira/browse/GROOVY-9547 > Project: Groovy > Issue Type: Bug > Components: GroovyDoc >Affects Versions: 3.0.3 >Reporter: Damir Murat >Assignee: Paul King >Priority: Minor > Fix For: 4.0.0-alpha-1, 3.0.4 > > Attachments: image-2020-05-11-00-25-12-464.png, > image-2020-05-11-00-25-58-871.png, image-2020-05-11-00-27-49-744.png > > Time Spent: 20m > Remaining Estimate: 0h > > With Groovy 3.0.3, Groovydoc does not render @see tags properly. When trying > to link on another class in the same package from the class description, the > linked class name is rendered, but the link is not created: > !image-2020-05-11-00-25-58-871.png! > Another case is when @see is used from a method description trying to link a > method in another class in the same package. In this scenario, method name is > duplicated, and the link is missing. Something like this: > !image-2020-05-11-00-27-49-744.png! > There might be other scenarios. These two are just those that I stumbled upon. -- This message was sent by Atlassian Jira (v8.3.4#803005)
[jira] [Created] (GROOVY-9551) Bump JavaParser to 3.15.22
Paul King created GROOVY-9551:
-
Summary: Bump JavaParser to 3.15.22
Key: GROOVY-9551
URL: https://issues.apache.org/jira/browse/GROOVY-9551
Project: Groovy
Issue Type: Dependency upgrade
Reporter: Paul King
Assignee: Paul King
Fix For: 4.0.0-alpha-1, 3.0.4
This fixes the groovydoc parsing error for
{{groovy.transform.builder.DefaultStrategy}}.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
[jira] [Resolved] (GROOVY-9546) Annotations on class signature are rendered incorrectly
[
https://issues.apache.org/jira/browse/GROOVY-9546?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Paul King resolved GROOVY-9546.
---
Resolution: Fixed
Merged. Thanks for spotting the issue and thanks to [~vmj] for the PR.
> Annotations on class signature are rendered incorrectly
> ---
>
> Key: GROOVY-9546
> URL: https://issues.apache.org/jira/browse/GROOVY-9546
> Project: Groovy
> Issue Type: Bug
> Components: GroovyDoc
>Affects Versions: 3.0.3
>Reporter: Damir Murat
>Assignee: Paul King
>Priority: Minor
> Attachments: image-2020-05-10-17-42-34-810.png,
> image-2020-05-10-17-47-00-858.png
>
> Time Spent: 1h 10m
> Remaining Estimate: 0h
>
> When I have an annotated class, generated groovydoc contains a link to the
> annotation and appended annotation name just after it as in following
> screenshot:
> !image-2020-05-10-17-47-00-858.png!
> After some debugging, I managed to fix the issue by modifying
> {code:java}
> org/codehaus/groovy/tools/groovydoc/gstringTemplates/classLevel/classDocName.html.annotations(){code}
> like this:
> {noformat}
> def annotations = { t, sepChar ->
> // t.annotations() ? t.annotations().collect{ it.isTypeAvailable() ? '@'
> + linkable(it.type().typeName()) + (it.description() -
> ('@'+it.type().typeName())) : it.description()}.join(sepChar) + sepChar : ''
> t.annotations() ? t.annotations().collect{ it.isTypeAvailable() ? '@' +
> linkable(it.type().typeName()) : it.description()}.join(sepChar) + sepChar :
> ''
> }
> {noformat}
>
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
[jira] [Resolved] (GROOVY-9551) Bump JavaParser to 3.15.22
[
https://issues.apache.org/jira/browse/GROOVY-9551?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Paul King resolved GROOVY-9551.
---
Resolution: Fixed
> Bump JavaParser to 3.15.22
> --
>
> Key: GROOVY-9551
> URL: https://issues.apache.org/jira/browse/GROOVY-9551
> Project: Groovy
> Issue Type: Dependency upgrade
>Reporter: Paul King
>Assignee: Paul King
>Priority: Major
> Fix For: 4.0.0-alpha-1, 3.0.4
>
>
> This fixes the groovydoc parsing error for
> {{groovy.transform.builder.DefaultStrategy}}.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
[jira] [Updated] (GROOVY-9546) Annotations on class signature are rendered incorrectly
[
https://issues.apache.org/jira/browse/GROOVY-9546?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Paul King updated GROOVY-9546:
--
Fix Version/s: 3.0.4
4.0.0-alpha-1
> Annotations on class signature are rendered incorrectly
> ---
>
> Key: GROOVY-9546
> URL: https://issues.apache.org/jira/browse/GROOVY-9546
> Project: Groovy
> Issue Type: Bug
> Components: GroovyDoc
>Affects Versions: 3.0.3
>Reporter: Damir Murat
>Assignee: Paul King
>Priority: Minor
> Fix For: 4.0.0-alpha-1, 3.0.4
>
> Attachments: image-2020-05-10-17-42-34-810.png,
> image-2020-05-10-17-47-00-858.png
>
> Time Spent: 1h 10m
> Remaining Estimate: 0h
>
> When I have an annotated class, generated groovydoc contains a link to the
> annotation and appended annotation name just after it as in following
> screenshot:
> !image-2020-05-10-17-47-00-858.png!
> After some debugging, I managed to fix the issue by modifying
> {code:java}
> org/codehaus/groovy/tools/groovydoc/gstringTemplates/classLevel/classDocName.html.annotations(){code}
> like this:
> {noformat}
> def annotations = { t, sepChar ->
> // t.annotations() ? t.annotations().collect{ it.isTypeAvailable() ? '@'
> + linkable(it.type().typeName()) + (it.description() -
> ('@'+it.type().typeName())) : it.description()}.join(sepChar) + sepChar : ''
> t.annotations() ? t.annotations().collect{ it.isTypeAvailable() ? '@' +
> linkable(it.type().typeName()) : it.description()}.join(sepChar) + sepChar :
> ''
> }
> {noformat}
>
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
[jira] [Resolved] (GROOVY-9465) GroovyDoc: class-header is not always displayed
[ https://issues.apache.org/jira/browse/GROOVY-9465?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Paul King resolved GROOVY-9465. --- Fix Version/s: 3.0.4 4.0.0-alpha-1 Resolution: Fixed Merged. Thanks for spotting the issue and thanks to [~vmj] for the PR. > GroovyDoc: class-header is not always displayed > --- > > Key: GROOVY-9465 > URL: https://issues.apache.org/jira/browse/GROOVY-9465 > Project: Groovy > Issue Type: Bug > Components: GroovyDoc >Reporter: Johannes Meyer >Assignee: Paul King >Priority: Critical > Fix For: 4.0.0-alpha-1, 3.0.4 > > Time Spent: 20m > Remaining Estimate: 0h > > The class-header and also the superclasses and annotations are not displayed > in all situation. > It can be seen here for example: > with header: > [https://docs.groovy-lang.org/latest/html/gapi/org/codehaus/groovy/transform/ASTTestTransformation.html] > without header: > [https://docs.groovy-lang.org/latest/html/gapi/org/apache/groovy/groovysh/commands/AliasCommand.html] > > I make some tests and I think the header is only generated when the class > implements an interface or a trait. > Without the class-header it difficult to see, from which class a class is > inherited. -- This message was sent by Atlassian Jira (v8.3.4#803005)
[jira] [Updated] (GROOVY-9522) Throwing NPE when I use ternary operator with something special
[
https://issues.apache.org/jira/browse/GROOVY-9522?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Daniel Sun updated GROOVY-9522:
---
Fix Version/s: 3.0.4
4.0.0-alpha-1
> Throwing NPE when I use ternary operator with something special
> ---
>
> Key: GROOVY-9522
> URL: https://issues.apache.org/jira/browse/GROOVY-9522
> Project: Groovy
> Issue Type: Bug
> Components: parser
>Affects Versions: 3.0.3
> Environment: Win10/MacOS
> Zulu OpenJDK 11
>Reporter: Huabin Zhang
>Priority: Critical
> Fix For: 4.0.0-alpha-1, 3.0.4
>
>
> Hi, I got NPE instead of empty string when I wrote the following snippet:
>
> {code:java}
> static String a() {
> null
> }
> static String b() {
> ''
> }
> def x = a() ? [b(), a()].join(',') : b() // NPE
> //def x = a() ? [b(), a()] : b() // OK
> //def x = a() ? ([b(), a()]).join(',') : b() // OK
> x == ''
> {code}
>
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
[jira] [Assigned] (GROOVY-9522) Throwing NPE when I use ternary operator with something special
[
https://issues.apache.org/jira/browse/GROOVY-9522?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Daniel Sun reassigned GROOVY-9522:
--
Assignee: Daniel Sun
> Throwing NPE when I use ternary operator with something special
> ---
>
> Key: GROOVY-9522
> URL: https://issues.apache.org/jira/browse/GROOVY-9522
> Project: Groovy
> Issue Type: Bug
> Components: parser
>Affects Versions: 3.0.3
> Environment: Win10/MacOS
> Zulu OpenJDK 11
>Reporter: Huabin Zhang
>Assignee: Daniel Sun
>Priority: Critical
> Fix For: 4.0.0-alpha-1, 3.0.4
>
>
> Hi, I got NPE instead of empty string when I wrote the following snippet:
>
> {code:java}
> static String a() {
> null
> }
> static String b() {
> ''
> }
> def x = a() ? [b(), a()].join(',') : b() // NPE
> //def x = a() ? [b(), a()] : b() // OK
> //def x = a() ? ([b(), a()]).join(',') : b() // OK
> x == ''
> {code}
>
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
[jira] [Created] (GROOVY-9548) groovydoc: properties claim to be "private" and don't show annotations
Mikko Värri created GROOVY-9548: --- Summary: groovydoc: properties claim to be "private" and don't show annotations Key: GROOVY-9548 URL: https://issues.apache.org/jira/browse/GROOVY-9548 Project: Groovy Issue Type: Bug Components: GroovyDoc Affects Versions: 3.0.3 Reporter: Mikko Värri Attachments: groovy-property-2_5_11.png, groovy-property-3_0_3.png In 2.5.11, properties don't have visibility modifiers and the annotations are shown: !groovy-property-2_5_11.png! In 3.0.3, they are claimed to be private (although, -private groovydoc flag wasn't used) and annotations are missing: !groovy-property-3_0_3.png! -- This message was sent by Atlassian Jira (v8.3.4#803005)
[jira] [Created] (GROOVY-9549) groovydoc: implemented interfaces not shown in class description
Mikko Värri created GROOVY-9549: --- Summary: groovydoc: implemented interfaces not shown in class description Key: GROOVY-9549 URL: https://issues.apache.org/jira/browse/GROOVY-9549 Project: Groovy Issue Type: Improvement Components: GroovyDoc Reporter: Mikko Värri Attachments: groovy-impl-interfaces.png, java-impl-interfaces.png *javadoc* shows the implemented interfaces in the class declaration header: !java-impl-interfaces.png! Groovydoc doesn't: !groovy-impl-interfaces.png! Is this by choice or should groovydoc follow javadoc? -- This message was sent by Atlassian Jira (v8.3.4#803005)
[GitHub] [groovy] paulk-asert commented on pull request #1244: GROOVY-9547: groovydoc: resolve tags later for Groovy source code
paulk-asert commented on pull request #1244: URL: https://github.com/apache/groovy/pull/1244#issuecomment-626632585 Merged, thanks! This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org
[jira] [Created] (GROOVY-9550) groovydoc: java classes don't seem to extend object
Mikko Värri created GROOVY-9550: --- Summary: groovydoc: java classes don't seem to extend object Key: GROOVY-9550 URL: https://issues.apache.org/jira/browse/GROOVY-9550 Project: Groovy Issue Type: Bug Components: GroovyDoc Reporter: Mikko Värri Attachments: groovy-extends-object.png, java-extends-object.png Groovy classes show Object as superclass: !groovy-extends-object.png! But Java classes do not: !java-extends-object.png! -- This message was sent by Atlassian Jira (v8.3.4#803005)
[GitHub] [groovy] vmj commented on a change in pull request #1243: GROOVY-9546: groovydoc: fix annotation rendering
vmj commented on a change in pull request #1243: URL: https://github.com/apache/groovy/pull/1243#discussion_r422957135 ## File path: subprojects/groovy-groovydoc/src/test/groovy/org/codehaus/groovy/tools/groovydoc/testfiles/anno/Groovy.groovy ## @@ -0,0 +1,39 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + *http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.codehaus.groovy.tools.groovydoc.testfiles.anno + +import groovy.transform.EqualsAndHashCode +import groovy.transform.NamedParam +import groovy.transform.NamedVariant + +// The annotations that are used here don't really matter, +// since groovydoc shows all annotations, not just @Documented ones. Review comment: Got it! [GROOVY-4634](https://issues.apache.org/jira/browse/GROOVY-4634) is probably it, then. This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org
[GitHub] [groovy] paulk-asert commented on a change in pull request #1243: GROOVY-9546: groovydoc: fix annotation rendering
paulk-asert commented on a change in pull request #1243: URL: https://github.com/apache/groovy/pull/1243#discussion_r422955255 ## File path: subprojects/groovy-groovydoc/src/test/groovy/org/codehaus/groovy/tools/groovydoc/testfiles/anno/Groovy.groovy ## @@ -0,0 +1,39 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + *http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.codehaus.groovy.tools.groovydoc.testfiles.anno + +import groovy.transform.EqualsAndHashCode +import groovy.transform.NamedParam +import groovy.transform.NamedVariant + +// The annotations that are used here don't really matter, +// since groovydoc shows all annotations, not just @Documented ones. Review comment: We do plan to correct this one day. We currently try to minimise resolving classes when not needed but we will likely change that at some point. This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org
[GitHub] [groovy] paulk-asert commented on a change in pull request #1243: GROOVY-9546: groovydoc: fix annotation rendering
paulk-asert commented on a change in pull request #1243: URL: https://github.com/apache/groovy/pull/1243#discussion_r422955255 ## File path: subprojects/groovy-groovydoc/src/test/groovy/org/codehaus/groovy/tools/groovydoc/testfiles/anno/Groovy.groovy ## @@ -0,0 +1,39 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + *http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.codehaus.groovy.tools.groovydoc.testfiles.anno + +import groovy.transform.EqualsAndHashCode +import groovy.transform.NamedParam +import groovy.transform.NamedVariant + +// The annotations that are used here don't really matter, +// since groovydoc shows all annotations, not just @Documented ones. Review comment: We do plan to correct @Documented behaviour one day. We currently try to minimise resolving classes when not needed but we will likely change that at some point. This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org
[GitHub] [groovy] paulk-asert commented on pull request #1243: GROOVY-9546: groovydoc: fix annotation rendering
paulk-asert commented on pull request #1243: URL: https://github.com/apache/groovy/pull/1243#issuecomment-626629940 Merged. Thanks! This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org
[GitHub] [groovy] vmj opened a new pull request #1244: GROOVY-9547: groovydoc: resolve tags later for Groovy source code
vmj opened a new pull request #1244: URL: https://github.com/apache/groovy/pull/1244 For Java source code, tags are resolved when the template asks for the comments. For Groovy, they were resolved as soon as the source file was processes. At that point, not all classes in the same package are processes, so links to those failed to link. This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org
[jira] [Commented] (GROOVY-9547) @see tags are not working properly
[ https://issues.apache.org/jira/browse/GROOVY-9547?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17104255#comment-17104255 ] Mikko Värri commented on GROOVY-9547: - For Java source files, all the tags seem to be resolved when the template asks for the comments. For Groovy, the comments are formatted right after reading the source file. So this issue, I think, only affects Groovy code. Created a PR that postpones the tag hanling for groovy source, too. > @see tags are not working properly > -- > > Key: GROOVY-9547 > URL: https://issues.apache.org/jira/browse/GROOVY-9547 > Project: Groovy > Issue Type: Bug > Components: GroovyDoc >Affects Versions: 3.0.3 >Reporter: Damir Murat >Priority: Minor > Attachments: image-2020-05-11-00-25-12-464.png, > image-2020-05-11-00-25-58-871.png, image-2020-05-11-00-27-49-744.png > > Time Spent: 10m > Remaining Estimate: 0h > > With Groovy 3.0.3, Groovydoc does not render @see tags properly. When trying > to link on another class in the same package from the class description, the > linked class name is rendered, but the link is not created: > !image-2020-05-11-00-25-58-871.png! > Another case is when @see is used from a method description trying to link a > method in another class in the same package. In this scenario, method name is > duplicated, and the link is missing. Something like this: > !image-2020-05-11-00-27-49-744.png! > There might be other scenarios. These two are just those that I stumbled upon. -- This message was sent by Atlassian Jira (v8.3.4#803005)
[jira] [Assigned] (GROOVY-9546) Annotations on class signature are rendered incorrectly
[
https://issues.apache.org/jira/browse/GROOVY-9546?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Paul King reassigned GROOVY-9546:
-
Assignee: Paul King
> Annotations on class signature are rendered incorrectly
> ---
>
> Key: GROOVY-9546
> URL: https://issues.apache.org/jira/browse/GROOVY-9546
> Project: Groovy
> Issue Type: Bug
> Components: GroovyDoc
>Affects Versions: 3.0.3
>Reporter: Damir Murat
>Assignee: Paul King
>Priority: Minor
> Attachments: image-2020-05-10-17-42-34-810.png,
> image-2020-05-10-17-47-00-858.png
>
> Time Spent: 20m
> Remaining Estimate: 0h
>
> When I have an annotated class, generated groovydoc contains a link to the
> annotation and appended annotation name just after it as in following
> screenshot:
> !image-2020-05-10-17-47-00-858.png!
> After some debugging, I managed to fix the issue by modifying
> {code:java}
> org/codehaus/groovy/tools/groovydoc/gstringTemplates/classLevel/classDocName.html.annotations(){code}
> like this:
> {noformat}
> def annotations = { t, sepChar ->
> // t.annotations() ? t.annotations().collect{ it.isTypeAvailable() ? '@'
> + linkable(it.type().typeName()) + (it.description() -
> ('@'+it.type().typeName())) : it.description()}.join(sepChar) + sepChar : ''
> t.annotations() ? t.annotations().collect{ it.isTypeAvailable() ? '@' +
> linkable(it.type().typeName()) : it.description()}.join(sepChar) + sepChar :
> ''
> }
> {noformat}
>
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
[GitHub] [groovy] paulk-asert commented on pull request #1242: GROOVY-9465: groovydoc: show class declaration header for all types
paulk-asert commented on pull request #1242: URL: https://github.com/apache/groovy/pull/1242#issuecomment-626628879 Good catch. Merged. Thanks! This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org
[GitHub] [groovy] vmj commented on pull request #1243: GROOVY-9546: groovydoc: fix annotation rendering
vmj commented on pull request #1243: URL: https://github.com/apache/groovy/pull/1243#issuecomment-626616314 Created a separate issue for the missing property annotations, since I couldn't yet figure it out: https://issues.apache.org/jira/browse/GROOVY-9548 This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org
[jira] [Commented] (GROOVY-9549) groovydoc: implemented interfaces not shown in class description
[ https://issues.apache.org/jira/browse/GROOVY-9549?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17104309#comment-17104309 ] Paul King commented on GROOVY-9549: --- Should be like Javadoc > groovydoc: implemented interfaces not shown in class description > > > Key: GROOVY-9549 > URL: https://issues.apache.org/jira/browse/GROOVY-9549 > Project: Groovy > Issue Type: Improvement > Components: GroovyDoc >Reporter: Mikko Värri >Priority: Minor > Attachments: groovy-impl-interfaces.png, java-impl-interfaces.png > > > *javadoc* shows the implemented interfaces in the class declaration header: > !java-impl-interfaces.png! > Groovydoc doesn't: > !groovy-impl-interfaces.png! > Is this by choice or should groovydoc follow javadoc? -- This message was sent by Atlassian Jira (v8.3.4#803005)
[GitHub] [groovy] paulk-asert commented on a change in pull request #1243: GROOVY-9546: groovydoc: fix annotation rendering
paulk-asert commented on a change in pull request #1243: URL: https://github.com/apache/groovy/pull/1243#discussion_r422963560 ## File path: subprojects/groovy-groovydoc/src/test/groovy/org/codehaus/groovy/tools/groovydoc/testfiles/anno/Groovy.groovy ## @@ -0,0 +1,39 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + *http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.codehaus.groovy.tools.groovydoc.testfiles.anno + +import groovy.transform.EqualsAndHashCode +import groovy.transform.NamedParam +import groovy.transform.NamedVariant + +// The annotations that are used here don't really matter, +// since groovydoc shows all annotations, not just @Documented ones. Review comment: That's the one. :-) This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org
[jira] [Commented] (GROOVY-9547) @see tags are not working properly
[ https://issues.apache.org/jira/browse/GROOVY-9547?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17104626#comment-17104626 ] Damir Murat commented on GROOVY-9547: - Already fixed. Wow, that's great :) If I understand correctly it is fixed for Groovy 4. Is it possible to squeeze it into the Groovy 3 branch or this is too much trouble? Same question for GROOVY-9546 > @see tags are not working properly > -- > > Key: GROOVY-9547 > URL: https://issues.apache.org/jira/browse/GROOVY-9547 > Project: Groovy > Issue Type: Bug > Components: GroovyDoc >Affects Versions: 3.0.3 >Reporter: Damir Murat >Priority: Minor > Attachments: image-2020-05-11-00-25-12-464.png, > image-2020-05-11-00-25-58-871.png, image-2020-05-11-00-27-49-744.png > > Time Spent: 20m > Remaining Estimate: 0h > > With Groovy 3.0.3, Groovydoc does not render @see tags properly. When trying > to link on another class in the same package from the class description, the > linked class name is rendered, but the link is not created: > !image-2020-05-11-00-25-58-871.png! > Another case is when @see is used from a method description trying to link a > method in another class in the same package. In this scenario, method name is > duplicated, and the link is missing. Something like this: > !image-2020-05-11-00-27-49-744.png! > There might be other scenarios. These two are just those that I stumbled upon. -- This message was sent by Atlassian Jira (v8.3.4#803005)
