Grails: Alternatives to Grails Doc? [closed]

Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.

---

Questions asking us to recommend or find a tool, library or favorite off-site resource are off-topic for Stack Overflow as they tend to attract opinionated answers and spam. Instead, describe the problem and what has been done so far to solve it.

开发者_开发技巧

Closed 9 years ago.

Improve this question

The documentation created by running grails doc is not completely satisfactory in my eyes. For example, actions in controllers appear as properties in the documentation, though I would wish to have an extra section to separate actions from actual properties (Strings etc.).

Are there any tools that operate on JavaDoc-like comments and generate better output for Grails projects? It should be either Grails-aware (i.e. understands that closures in controllers are actually actions) or allow explicit tagging (e.g. a @section Actions comment makes the paragraph appear in a section called "Actions")

---

Take a look at the grails-new-doc project.

---

Check out "Grails Runtime Docs" plugin ( http://grails.org/plugin/grails-runtime-docs ). It will generate groovy documentation from runtime including the dynamic methods, adding "Dynamic Method Summary" & "Dynamic Method Detail" in the generated html docs which provide their source information. It's more Grails aware and categorizes the classes into Controllers, Commands, Domains, Services and Tag Libraries. Note: I'm a grails developer and contributed this open-source plugin to Grails myself. Hope you find it useful.

---

It sounds like you are running an older version of Grails.

The latest version of Grails contains many improvements in grails doc. In addition, Grails now recommends controller actions should be coded as methods rather than closures, which may address your issue.

If you are concerned about upgrading, I've been using Grails since 2008 and always upgrade when new versions come out.

It has never taken more than one day to upgrade Grails, update code to address any documented "breaking changes", run the tests, and revert if I find any issues.

Since upgrading is so easy, I always try to keep up with the latest stable release.

By the way plugins can be problematic. You should, or course, have tests for any plugins you use. In fact the better plugins already include tests, which you can run.