Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How to create javadoc of a grails project

Tags:

javadoc

grails

There is a way to create javadoc for a grails project? (It makes sense?)

like image 316
tapioco123 Avatar asked Jun 17 '10 16:06

tapioco123


People also ask

How do you create a javadoc file?

From the main menu, select Tools | Generate JavaDoc. In the dialog that opens, select a scope — a set of files or directories for which you want to generate the reference, and set the output directory where the generated documentation will be placed.

What is javadoc and How to create it?

To generate JavaDoc in Eclipse: – Select “Generate JavaDoc” option from Project menu and a wizard will appear. Specify the location for the JavaDoc file on your computer, by default it will be in the C drive. Select the project and then the packages for which you want to create the JavaDoc file.

How do I export a javadoc?

In Eclipse, go to File > Export. Expand Java and select Javadoc. Then click Next. Select your project and package.

Which application exe is involved to create javadoc?

Step 1 − Open eclipse, select the option Project →Generate Javadoc. Step 2 − Select the javadoc.exe file from the bin folder of java installation directory, select the destination folder for the generated java doc and select Next.


2 Answers

grails doc and look for your docs in target/docs/api (Java) and target/docs/gapi (Groovy).

like image 170
ataylor Avatar answered Sep 20 '22 12:09

ataylor


'grails-runtime-docs' plugin ( http://grails.org/plugin/grails-runtime-docs , contributed to grails by myself) is more grails aware. It will also generate the dynamic methods and also categorize the classes into Controllers, Commands, Domains, Services and Tag Libraries.

Run:- grails install-plugin grails-runtime-docs and then grails runtime-docs

like image 34
Srinath Anantha Avatar answered Sep 20 '22 12:09

Srinath Anantha