Stack Overflow
Stack Overflow

Questions tagged [groovydoc]

GroovyDoc is Groovy's equivalent for JavaDoc

37 questions
11
votes
1 answer

How can I get javadocs / groovydocs for groovy methods in an IntelliJ IDEA Grails project?

When working in a Grails project, I don't get any useful javadocs / groovydocs for the GDK methods that groovy adds to things like collections. Is there a way to do this, or is this something IntelliJ IDEA just can't do?
cdeszaq
  • 30,869
  • 25
  • 117
  • 173
9
votes
1 answer

What are the 3 types of JavaDocs for Groovy 1.8?

The Groovy 1.8 docs have 3 types of JavaDocs: api/ gapi/ jdk/ The jdk/ Javadocs show methods that Groovy adds to Java classes. That's easy to understand. The JavaDocs in api/ and gapi/ are confusing. They are similar except that api/ has a…
Dean Schulze
  • 9,633
  • 24
  • 100
  • 165
8
votes
4 answers

GroovyDoc as Maven Plugin

Is there a maven plugin available somewhere that utilizes GroovyDoc, preferably as a report? I guess GMaven would be the place to look but the docs are ancient (1.0, whereas the current version is 1.3) and the GMaven plugin doesn't have any mojo…
Sean Patrick Floyd
  • 292,901
  • 67
  • 465
  • 588
8
votes
5 answers

How to generate groovydoc from jenkins global library

I have a jenkins global library and I want to document it. I want to use groovydoc. The library contains classes and global vars src/ vars Generating documentation for the classes is no problem: groovydoc -sourcepath src -d doc…
Nathan
  • 7,099
  • 14
  • 61
  • 125
6
votes
1 answer

Combining multiple source language documentations into a single Javadoc JAR

If I have a project that has java, groovy, and kotlin plugins applied with code written in each, how do I create (and should I) create a single javadoc.jar distribution with all of the code documentation? The java plugin gives me the javadoc class,…
mkobit
  • 43,979
  • 12
  • 156
  • 150
6
votes
2 answers

Groovydoc: Documenting named parameters

I've created a method like so: void myMethod(Map kwArgs, def myParam) { println kwArgs.firstName println [kwArgs.lastName, "Wilcox"].find() // ^^^ if lastName named parameter not specified, "Wilcox" .... } Now comes the time to…
RyanWilcox
  • 13,890
  • 1
  • 36
  • 60
5
votes
1 answer

Is there a way to attach a Javadoc doc comment to a Groovy script?

For a Groovy or Java class or method, I would generally include any API-level documentation in a doc comment (aka Javadoc comment), rather than a regular comment. What is the analogous way of adding such comments about a Groovy script? I personally…
M. Justin
  • 14,487
  • 7
  • 91
  • 130
4
votes
1 answer

Generate groovydoc without compiling Groovy sources using Gradle

I am trying to generate docs from some groovy code but Gradle fails because it can't import the dependencies when trying to compile the code. This is expected since that code needs to run in a specific context before those dependencies are…
ConfusedAgain
  • 83
  • 1
  • 9
4
votes
1 answer

groovydoc for local package links

In my groovy file, I have a groovydoc link that looks like: /** * This links to {@link MyClassInSamePackage} */ def myMethod() { } Because the class of myMethod is the same package as MyClassInSamePackage, this should work, but it doesn't…
Jeff Storey
  • 56,312
  • 72
  • 233
  • 406
3
votes
0 answers

IntelliJ "Generate Groovydoc" stop working

I used the Tools -> Generate Groovydoc... without any problems, but now its stopped working. If i create new projects i don't have this option. Can i see logs somehow about the doc generation? I don't know where can i start the investigation. IDEA…
Apoth
  • 353
  • 5
  • 13
3
votes
0 answers

How to create a custom groovy doclet?

I would like to create a custom doclet in my groovy source, but I can´t find any possibility since the groovydoc tool has no -taglet parameter. I digged a bit in the API, but no luck. Is there a way to write a custom doclet?
thilko
  • 587
  • 5
  • 15
2
votes
2 answers

grails-doc creates copies of my classes in default package

In my grails 1.3.7 project, I have put all of my classes in com.mycompany.myapp, as you do. So this goes for services, controllers, domain classes. I have a filter that goes in its own package. My app works fine. However, when I run grails doc,…
Hans Westerbeek
  • 5,645
  • 3
  • 34
  • 35
2
votes
3 answers

Where has the Groovy documentation gone?

When I search Groovy javadocs (groovydocs, whatever) I find it in Google, but they all redirect to a kind of Groovy splash page saying how good Groovy is. For example, when I search "groovy uribuilder api" the link…
orbfish
  • 7,381
  • 14
  • 58
  • 75
2
votes
3 answers

Groovydoc produces blank documents

I'm writing a class in Groovy, and I want to generate Groovydoc for it (from the command line). In my class, I've written documentation for the methods like this: /** * Returns blah blah blah */ def getFoo(){ ... } But when I run groovydoc…
Steve
  • 4,457
  • 12
  • 48
  • 89
2
votes
2 answers

Gradle task groovyDoc failing with NoClassDefFoundError

I'm using Gradle 1.5 to test my Groovy scripts. The groovyDoc task in build.gradle is set up like: groovydoc { docTitle = "Name" windowTitle = "Name" destinationDir = file('file://path') } The error I'm getting when running this task…
twbbas
  • 407
  • 3
  • 9
  • 19
1
2 3