You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@groovy.apache.org by "Mikko Värri (Jira)" <ji...@apache.org> on 2020/05/26 13:08:00 UTC

[jira] [Created] (GROOVY-9572) groovydoc: some __$stMC field is inherited from base class

Mikko Värri created GROOVY-9572:
-----------------------------------

             Summary: groovydoc: some __$stMC field is inherited from base class
                 Key: GROOVY-9572
                 URL: https://issues.apache.org/jira/browse/GROOVY-9572
             Project: Groovy
          Issue Type: Bug
          Components: GroovyDoc
            Reporter: Mikko Värri
         Attachments: groovydoc-stmc.png

Not sure if this is a bug or an improvement suggestion: hide {{__$stMC}} inherited field.

h6. Steps to reproduce

*Given* a base class:

{code:title=./Base.groovy}
package base

class Base {
}
{code}

In the real world this is provided by another project.

The base class can also be abstract, but is has to be a Groovy class.

*And* compile the base class, because it needs to be on the classpath when documenting the derived class.  Otherwise this bug won't show up.

{code}
groovyc -d=classes Base.groovy
{code}

*And*, have a derived class:

{code:title=./Derived.groovy}
import base.Base

class Derived extends Base {
}
{code}

*When* API docs are generated for this derived class:

{code}
groovydoc -classpath classes --destdir=docs Derived.groovy
{code}

Then an inherited field {{__$stMC}} is shown in the docs:

 !groovydoc-stmc.png! 

Technically those docs are probably telling the truth, but I think it should be hidden.




--
This message was sent by Atlassian Jira
(v8.3.4#803005)