Generating documentation

Documentation is one of the important part of development life cycle, which does not get enough attention from developers. If code is not properly documented, it always increases the maintenance efforts and also it takes time for the new team member to understand the code, if the code lacks the documentation. When you apply Java plugin to your build file, Gradle provides you a javadoc task. By default, Gradle generates the initial documentation for your code, even if the user does not mention any Javadoc in the file.

Consider the following Java sample code:

package ch6;
public class SampleTask  {
  public static void main(String[] args) {
    System.out.println("Building Project");

  }
  public String greetings(String name) {
    return "hello "+name;
  }
}

Now, try to execute the following command:

> gradle clean javadoc
:clean
:cleanDir
:createDirs
:compileJava
:processResources UP-TO-DATE
:classes
:javadoc

BUILD SUCCESSFUL

Total time: 4.341 secs

This command...