Fix javadoc warnings

Author: stefanseifert

model/src/main/java/io/wcm/devops/conga/model/environment/RoleConfig.java

@@ -37,6 +37,10 @@ public String getRole() {
     return this.role;
   }
 
+  /**
+   * Sets role name.
+   * @param role Role name
+   */
   public void setRole(String role) {
     this.role = role;
   }

model/src/main/java/io/wcm/devops/conga/model/environment/Tenant.java

@@ -45,6 +45,10 @@ public String getTenant() {
     return this.tenant;
   }
 
+  /**
+   * Sets tenant name.
+   * @param tenant Tenant name
+   */
   public void setTenant(String tenant) {
     this.tenant = tenant;
   }
@@ -58,6 +62,10 @@ public List<String> getRoles() {
     return this.roles;
   }
 
+  /**
+   * Sets tenant roles.
+   * @param roles List of tenant role names
+   */
   public void setRoles(List<String> roles) {
     this.roles = defaultEmptyList(roles);
   }

model/src/main/java/io/wcm/devops/conga/model/role/Role.java

@@ -64,6 +64,10 @@ public List<RoleVariant> getVariants() {
     return this.variants;
   }
 
+  /**
+   * Sets role variants.
+   * @param variants List of role variant definitions
+   */
   public void setVariants(List<RoleVariant> variants) {
     this.variants = defaultEmptyList(variants);
   }
@@ -77,6 +81,10 @@ public String getTemplateDir() {
     return this.templateDir;
   }
 
+  /**
+   * Sets template directory.
+   * @param templateDirectory Relative path to template files
+   */
   public void setTemplateDir(String templateDirectory) {
     this.templateDir = templateDirectory;
   }
@@ -89,6 +97,10 @@ public List<RoleFile> getFiles() {
     return this.files;
   }
 
+  /**
+   * Sets files.
+   * @param files List of file definitions
+   */
   public void setFiles(List<RoleFile> files) {
     this.files = defaultEmptyList(files);
   }
@@ -102,6 +114,10 @@ public List<String> getSensitiveConfigParameters() {
     return defaultEmptyList(this.sensitiveConfigParameters);
   }
 
+  /**
+   * Sets sensitive configuration parameters.
+   * @param sensitiveProperties List of configuration parameter names
+   */
   public void setSensitiveConfigParameters(List<String> sensitiveProperties) {
     this.sensitiveConfigParameters = sensitiveProperties;
   }

model/src/main/java/io/wcm/devops/conga/model/role/RoleFile.java

@@ -74,6 +74,10 @@ public String getFile() {
     return this.file;
   }
 
+  /**
+   * Sets file name.
+   * @param name File name
+   */
   public void setFile(String name) {
     this.file = name;
   }
@@ -89,6 +93,10 @@ public String getDir() {
     return this.dir;
   }
 
+  /**
+   * Sets directory.
+   * @param dir Directory name
+   */
   public void setDir(String dir) {
     this.dir = dir;
   }
@@ -102,6 +110,10 @@ public String getTemplate() {
     return this.template;
   }
 
+  /**
+   * Sets template name.
+   * @param template Template file name
+   */
   public void setTemplate(String template) {
     this.template = template;
   }
@@ -116,6 +128,10 @@ public String getUrl() {
     return this.url;
   }
 
+  /**
+   * Sets download URL.
+   * @param url Download URL
+   */
   public void setUrl(String url) {
     this.url = url;
   }
@@ -130,6 +146,10 @@ public String getSymlinkTarget() {
     return this.symlinkTarget;
   }
 
+  /**
+   * Sets symlink target.
+   * @param symlinkTarget Symlink target
+   */
   public void setSymlinkTarget(String symlinkTarget) {
     this.symlinkTarget = symlinkTarget;
   }
@@ -147,11 +167,16 @@ public List<String> getVariants() {
     return this.variants;
   }
 
+  /**
+   * Sets role variant names.
+   * @param variants List of role variant names
+   */
   public void setVariants(List<String> variants) {
     this.variants = defaultEmptyList(variants);
   }
 
   /**
+   * Gets variant metadata.
    * @return List of variants with metadata ("*" suffix is parsed)
    */
   public List<RoleFileVariantMetadata> getVariantsMetadata() {
@@ -170,6 +195,10 @@ public String getCondition() {
     return this.condition;
   }
 
+  /**
+   * Sets condition.
+   * @param condition Condition expression
+   */
   public void setCondition(String condition) {
     this.condition = condition;
   }
@@ -184,6 +213,10 @@ public String getFileHeader() {
     return this.fileHeader;
   }
 
+  /**
+   * Sets file header plugin name.
+   * @param fileHeader File header plugin name
+   */
   public void setFileHeader(String fileHeader) {
     this.fileHeader = fileHeader;
   }
@@ -198,6 +231,10 @@ public List<String> getValidators() {
     return this.validators;
   }
 
+  /**
+   * Sets validator plugin names.
+   * @param validators List of validator plugin names
+   */
   public void setValidators(List<String> validators) {
     this.validators = defaultEmptyList(validators);
   }
@@ -212,6 +249,10 @@ public Map<String, Object> getValidatorOptions() {
   }
 
 
+  /**
+   * Sets validator options.
+   * @param validatorOptions Configuration parameters
+   */
   public void setValidatorOptions(Map<String, Object> validatorOptions) {
     this.validatorOptions = defaultEmptyMap(MapExpander.expand(validatorOptions));
   }
@@ -224,6 +265,10 @@ public List<String> getPostProcessors() {
     return this.postProcessors;
   }
 
+  /**
+   * Sets post processor plugin names.
+   * @param postProcessors List of post processor plugin names
+   */
   public void setPostProcessors(List<String> postProcessors) {
     this.postProcessors = defaultEmptyList(postProcessors);
   }
@@ -247,6 +292,10 @@ public Map<String, Object> getPostProcessorOptions() {
     return this.postProcessorOptions;
   }
 
+  /**
+   * Sets post processor options.
+   * @param postProcessorOptions Configuration parameters
+   */
   public void setPostProcessorOptions(Map<String, Object> postProcessorOptions) {
     this.postProcessorOptions = defaultEmptyMap(MapExpander.expand(postProcessorOptions));
   }
@@ -261,6 +310,10 @@ public String getMultiply() {
     return this.multiply;
   }
 
+  /**
+   * Sets multiply plugin name.
+   * @param multiply Multiply plugin name
+   */
   public void setMultiply(String multiply) {
     this.multiply = multiply;
   }
@@ -274,6 +327,10 @@ public Map<String, Object> getMultiplyOptions() {
     return this.multiplyOptions;
   }
 
+  /**
+   * Sets multiply options.
+   * @param multiplyOptions Configuration parameters
+   */
   public void setMultiplyOptions(Map<String, Object> multiplyOptions) {
     this.multiplyOptions = defaultEmptyMap(MapExpander.expand(multiplyOptions));
   }
@@ -287,6 +344,10 @@ public String getCharset() {
     return this.charset;
   }
 
+  /**
+   * Sets charset.
+   * @param charset Charset name
+   */
   public void setCharset(String charset) {
     this.charset = charset;
   }
@@ -300,6 +361,10 @@ public LineEndings getLineEndings() {
     return this.lineEndings;
   }
 
+  /**
+   * Sets line endings style.
+   * @param lineEndings Line endings style
+   */
   public void setLineEndings(LineEndings lineEndings) {
     this.lineEndings = lineEndings;
   }
@@ -314,6 +379,10 @@ public String getEscapingStrategy() {
     return this.escapingStrategy;
   }
 
+  /**
+   * Sets escaping strategy plugin name.
+   * @param escapingStrategy Handlebars escaping strategy plugin name
+   */
   public void setEscapingStrategy(String escapingStrategy) {
     this.escapingStrategy = escapingStrategy;
   }
@@ -327,6 +396,10 @@ public Map<String, Object> getModelOptions() {
   }
 
 
+  /**
+   * Sets model options.
+   * @param modelOptions Model options
+   */
   public void setModelOptions(Map<String, Object> modelOptions) {
     this.modelOptions = modelOptions;
   }
@@ -341,6 +414,10 @@ public boolean isDeleteSource() {
     return this.deleteSource;
   }
 
+  /**
+   * Sets delete source flag.
+   * @param deleteSource true if the source file should be deleted
+   */
   public void setDeleteSource(boolean deleteSource) {
     this.deleteSource = deleteSource;
   }
@@ -366,13 +443,15 @@ public static class RoleFileVariantMetadata {
     }
 
     /**
+     * Gets variant name.
      * @return Variant name (without "*" suffix)
      */
     public String getVariant() {
       return this.variant;
     }
 
     /**
+     * Checks if variant is mandatory.
      * @return true if variant is mandatory (was suffixed with "*")
      */
     public boolean isMandatory() {

model/src/main/java/io/wcm/devops/conga/model/role/RoleInherit.java

@@ -37,6 +37,10 @@ public String getRole() {
     return this.role;
   }
 
+  /**
+   * Sets role name.
+   * @param role Role name
+   */
   public void setRole(String role) {
     this.role = role;
   }

model/src/main/java/io/wcm/devops/conga/model/role/RoleVariant.java

@@ -37,6 +37,10 @@ public String getVariant() {
     return this.variant;
   }
 
+  /**
+   * Sets variant name.
+   * @param variant Variant name
+   */
   public void setVariant(String variant) {
     this.variant = variant;
   }