init documentation

Author: AymericHenouille

README.md

@@ -48,7 +48,7 @@ $> ./gradlew build
 ```
 
 ### *Step 4: Use your module.* <a id="start-4"></a>
-Take the built module and put it in the *modules* file of your HomeTracker server.  
+Take the built module and put it in the *modules* file of your Modulo server.  
 
 > Enjoy 🍻 🌶🧀 
 

src/main/groovy/com/chillycheesy/modulo/ModuloApplicationPlugin.groovy

@@ -5,8 +5,15 @@ import com.chillycheesy.modulo.tasks.GenerateModuleYmlTask
 import org.gradle.api.Project
 import org.gradle.api.Plugin
 
+/**
+ * The plugin class with the apply method.
+ */
 class ModuloApplicationPlugin implements Plugin<Project> {
 
+    /**
+     * Init the plugin with the project.
+     * @param project The project who apply the plugin.
+     */
     @Override
     void apply(Project project) {
         project.pluginManager.apply 'java-library'

src/main/groovy/com/chillycheesy/modulo/extensions/ModuleExtension.groovy

@@ -2,51 +2,107 @@ package com.chillycheesy.modulo.extensions
 
 import org.gradle.api.Project
 
+/**
+ * The ModuleExtension store plugin.yml data.
+ */
 class ModuleExtension {
 
+    /**
+     * Define name.
+     * **Default: the project name.**
+     */
     String moduleName
+    /**
+     * Define main.
+     * **Default: {the project group}.{the project name}**
+     */
     String main
+    /**
+     * Define version.
+     * **Default: the project version.**
+     */
     String version
+    /**
+     * Define the path where generate the plugin.yml file
+     */
     String target
+    /**
+     * Define authors.
+     * **Default: src/main/resources**
+     */
     List<String> authors = ['ChillyCheesy']
+    /**
+     * Define dependencies.
+     */
     List<String> dependencies = []
+    /**
+     * Define softDependencies
+     */
     List<String> softDependencies = []
 
+    /**
+     * Init the extension with default values.
+     * @param project The target project.
+     */
     ModuleExtension(Project project) {
         moduleName = project.name
         version = project.version
         main = "${project.group.toString()}.${moduleName}"
         target = "${project.projectDir.path}/src/main/resources"
     }
 
+    /**
+     * Set the name.
+     * @param moduleName The new name.
+     */
     void moduleName(String moduleName) {
         this.moduleName = moduleName
     }
 
+    /**
+     * Set the main.
+     * @param main The new main.
+     */
     void main(String main) {
         this.main = main
     }
 
+    /**
+     * Set the version.
+     * @param version The new Version.
+     */
     void version(String version) {
         this.version = version
     }
 
+    /**
+     * Set the path where generate the plugin.yml file.
+     * @param target The new path
+     */
     void target(String target) {
         this.target = target
     }
 
-    void mainPageName(String mainPageName) {
-        this.mainPageName = mainPageName
-    }
-
+    /**
+     * Set the authors.
+     * @param authors The new authors List.
+     */
     void authors(List<String> authors) {
         this.authors = authors
     }
 
+    /**
+     * Set the dependencies
+     * @param dependencies The new dependencies List.
+     */
     void dependencies(List<String> dependencies) {
         this.dependencies = dependencies
     }
 
+    /**
+     * Set the soft dependencies
+     * @param softDependencies The new soft dependencies List.
+     */
     void softDependencies(List<String> softDependencies) {
         this.softDependencies = softDependencies
     }

src/main/groovy/com/chillycheesy/modulo/tasks/GenerateModuleYmlTask.groovy

@@ -1,17 +1,33 @@
 package com.chillycheesy.modulo.tasks
 
-
+import com.chillycheesy.modulo.extensions.ModuleExtension
 import org.gradle.api.Project
 import org.yaml.snakeyaml.Yaml
 
+/**
+ * The GenerateModuleYmlTask generate the module.yml file before the Plugin build.
+ * The task use the {@link ModuleExtension} information to generate it.
+ */
 class GenerateModuleYmlTask implements ModuloTask {
 
-    private com.chillycheesy.modulo.extensions.ModuleExtension moduleExtension
+    /**
+     * The ModuleExtension store plugin.yml data.
+     */
+    private ModuleExtension moduleExtension
 
-    GenerateModuleYmlTask(com.chillycheesy.modulo.extensions.ModuleExtension moduleExtension) {
+    /**
+     * Create the Task
+     * @param moduleExtension The module extention who store plugin.yml data
+     */
+    GenerateModuleYmlTask(ModuleExtension moduleExtension) {
         this.moduleExtension = moduleExtension
     }
 
+    /**
+     * Create the task.
+     * @param project Target project.
+     * @return The new task
+     */
     @Override
     def generate(Project project) {
         return project.task('generateModuleYml') {
@@ -32,6 +48,10 @@ class GenerateModuleYmlTask implements ModuloTask {
         }
     }
 
+    /**
+     * Get the module.yml file and create it if doesn't exist.
+     * @return The file.
+     */
     private def getModuleConfigFile() {
         final resources = new File("${moduleExtension.target}")
         resources.mkdirs()

src/main/groovy/com/chillycheesy/modulo/tasks/ModuloTask.groovy

@@ -2,6 +2,15 @@ package com.chillycheesy.modulo.tasks
 
 import org.gradle.api.Project
 
+/**
+ * Define a custom Modulo Task.
+ */
 interface ModuloTask {
+
+    /**
+     * Generate the custom task and return it.
+     * @param project The target project where add the task.
+     * @return The created task.
+     */
     def generate(Project project)
 }