spock icon indicating copy to clipboard operation
spock copied to clipboard

Publish Groovydoc

Open robfletcher opened this issue 8 years ago • 4 comments

Originally reported on Google Code with ID 237

We already publish Javadoc, but not yet Groovydoc. Figure this out.

Reported by pniederw on 2012-02-27 03:20:35

robfletcher avatar Aug 30 '15 13:08 robfletcher

Reported by pniederw on 2012-10-04 06:46:56

  • Labels added: Milestone-1.0
  • Labels removed: Milestone-0.7

robfletcher avatar Aug 30 '15 13:08 robfletcher

There's now http://groovydoc.spockframework.org/latest, and the plan is to publish Groovydoc
for each release.

Reported by pniederw on 2013-03-17 22:49:20

robfletcher avatar Aug 30 '15 13:08 robfletcher

Reported by pniederw on 2015-03-01 23:45:49

  • Labels added: Milestone-1.1
  • Labels removed: Milestone-1.0

robfletcher avatar Aug 30 '15 13:08 robfletcher

This is still open after 4 years. Why, is it so difficult and time-consuming? For example, http://spockframework.org/spock/javadoc/1.3/spock/util/concurrent/package-tree.html lists classes

  • AsyncConditions
  • BlockingVariable<T>
  • PollingConditions

but not class BlockingVariables because the latter is implemented in Groovy. This is really bad and distorts the picture of features available in Spock, especially given the fact that the Spock manual does not describe these fours classes, except for a release note example of PollingConditions which also mentions the other classes, but does not point to any documentation.

This gets worse by the fact that neither the Spock manual nor the website point to the Javadoc/Groovydoc, so if you don't happen to google the Javadoc (finding an old version) and then manually change the version number in the opened URL, there is no chance to find it at all, even though the Javadoc/Groovydoc for those four classes contains comprehensive sample code. It is a waste of resources to document something and then not make he documentation accessible. I work around that by knowing the class names and then opening them from my IDE, reading the Javadoc from there - very ugly.

Update: The URLs

  • http://groovydoc.spockframework.org/latest or
  • https://groovydoc.spockframework.org/latest

mentioned above are also unavailable.

kriegaex avatar Sep 11 '19 04:09 kriegaex