Stack Overflow
Stack Overflow

Questions tagged [groovydoc]

GroovyDoc is Groovy's equivalent for JavaDoc

37 questions
2
votes
0 answers

How do I get GroovyDoc to properly document return types with generic type parameters?

I have an ant task that generates GroovyDoc defined in my Maven pom file. Everything is looking great except that the method documentation for methods that return something like this: List are documented with List as the return…
Selena
  • 2,208
  • 8
  • 29
  • 49
2
votes
2 answers

How to set character encoding for Groovydoc in Gradle?

I have Groovy code with UTF-8 encoding and need the generated Groovydoc HTML to use the same. But how do I configure this in Gradle?
Lars Høidahl
  • 460
  • 4
  • 7
1
vote
1 answer

What is the full list of supported groovydoc tags and its syntax?

Does groovydoc support everything javadoc supports? Does it support the @see, @code and the @link tag? This is the only thing official I could find: https://docs.groovy-lang.org/latest/html/documentation/#_groovydoc_comment Where is the full…
red888
  • 27,709
  • 55
  • 204
  • 392
1
vote
1 answer

Is there a standard way to document groovy map properties?

Is there a standard way to document map properties in Groovy? For the following function the config contains multiple optional properties like: ignore dir tags def publish(Map config) { config.ignore ?= true // ... } I looked at What is the…
djthoms
  • 3,026
  • 2
  • 31
  • 56
1
vote
0 answers

Problem with {@link } documentation tags using Intellij and Gradle groovydoc task

I am trying to create documentation for a Groovy library using Intellij (2109.3.3) with a Gradle build using the groovydoc task in the Gradle window. The structure of the library is as follows: The component used (AnyGroupOfPipelineCollects) is…
Jon Kerridge
  • 76
  • 1
  • 3
1
vote
0 answers

Problems with Groovy Doc

I'm trying to generate Java documentation of a Grails 2.4.3 project but I'm getting an error and nothing is generated. grails doc --verbose The result is: [groovydoc] java.lang.StringIndexOutOfBoundsException: String index out of range:…
xabedev
  • 31
  • 3
1
vote
1 answer

What happened to »grails doc« in grails3?

The grails 2.x doc feature looks really helpful/promising: http://grails.github.io/grails-doc/2.5.3/ref/Command%20Line/doc.html It says that the command »grails doc« - »Generates a user guide and Javadoc + Groovydoc API documentation for the current…
Freitags
  • 330
  • 1
  • 10
1
vote
1 answer

Generate groovydoc and include sub directories

I have groovy scripts in different locations under a parent directory. Directory structure is kinda like this: magento └── magento.groovy └── models ├── cart.groovy ├── catalog.groovy ├── customer.groovy ├── directory.groovy ├──…
Raji Zen
  • 11
  • 3
1
vote
0 answers

New groovydoc syntax (markup) wiki-alike

I saw somewhere in the Groovy family new groovydoc markup (syntax of comments). It was similar to Wiki markup languages, not Javadoc. I had lost url and CAN'T FIND in google :(. Name of this doc formatter was very simply, normal english word. Can…
Jacek Cz
  • 1,872
  • 1
  • 15
  • 22
1
vote
1 answer

Any way to make Groovydoc remove (selected) package qualifiers as per Javadoc's 'noqualifier' option?

I've just started generating Groovydoc for a library I'm working on. However, the preponderance of java.lang and java.util and other common package prefixes in the method signatures is obscuring the real intent of the methods. I'd like to be able…
Paul
  • 3,009
  • 16
  • 33
1
vote
0 answers

Can groovydoc handle the autogenerated get/set methods?

I have a library I wrote in groovy, and I would like to make it available for Java users. When I use groovydoc to generate documentation, however, it doesn't include any of the get/set methods for my class properties. Is there a way to make it…
Donald Morton
  • 11
  • 2
1
vote
1 answer

Generate a jar file from groovydoc with maven

Is there some way to generate a jar file to be used in IDE's (like IDEA, Eclipse,...) from groovydoc that is generated from within maven? I'm currently generating groovydoc from a quite big groovy project with the maven antrun plugin described here:…
schneida
  • 729
  • 3
  • 11
  • 37
0
votes
0 answers

What is the best way to document Groovy class properties if Javadoc's @param tag doesn't fit?

I have a Groovy class definition which looks like the following: package packageC; import packageA.ClassA1; import packageA.ClassA2; import packageB.ClassB1; class BuildConfig implements Serializable { String projectId; String…
Andrew Parsons
  • 84
  • 2
  • 8
0
votes
0 answers

Gradle : Skipping task ':groovydoc' as it has no source files and no previous output files

I'm trying to create groovydoc using gradle. I have created the below task : The groovy classes are present in - src/integration-test/groovy/com/x/folders/*.groovy This is my sourcesets : sourceSets { integrationTestCompile { java { …
Saili Gaitonde
  • 99
  • 1
  • 1
  • 8
0
votes
0 answers

Is it possible to use custom templates to properly document a groovy script in groovydoc?

I have a groovy script/closure that is defined in a file named "myClosure.groovy" and the contents look like this: # myClosure.groovy def call(Map config) { ..... } I need to keep the code this way. I want to document this with groovydoc, but I'm…
red888
  • 27,709
  • 55
  • 204
  • 392
1
2
3