Cosmetic: Fix javadoc warnings (#164)

Author: stefanseifert

generator/src/main/java/io/wcm/devops/conga/generator/Generator.java

@@ -44,6 +44,7 @@ public final class Generator {
   private final Map<String, Environment> environments;
 
   /**
+   * Constructor.
    * @param options Generator options
    */
   public Generator(GeneratorOptions options) {

generator/src/main/java/io/wcm/devops/conga/generator/GeneratorException.java

@@ -26,13 +26,15 @@ public final class GeneratorException extends RuntimeException {
   private static final long serialVersionUID = 1L;
 
   /**
+   * Constructor.
    * @param message Message
    */
   public GeneratorException(String message) {
     super(message);
   }
 
   /**
+   * Constructor.
    * @param message Message
    * @param cause Cause
    */

generator/src/main/java/io/wcm/devops/conga/generator/GeneratorOptions.java

@@ -79,13 +79,15 @@ public final class GeneratorOptions {
   private Logger logger = LoggerFactory.getLogger(Generator.class);
 
   /**
+   * Gets base directory.
    * @return Base directory for resolving relative file references
    */
   public File getBaseDir() {
     return this.baseDir;
   }
 
   /**
+   * Sets base directory.
    * @param value Base directory for resolving relative file references
    * @return this
    */
@@ -103,6 +105,7 @@ public File getRoleDir() {
   }
 
   /**
+   * Sets role directory.
    * @param value Directory with role definitions. Filename without extension = role name.
    * @return this
    */
@@ -120,6 +123,7 @@ public File getTemplateDir() {
   }
 
   /**
+   * Sets template directory.
    * @param value Template base directory
    * @return this
    */
@@ -137,6 +141,7 @@ public File getEnvironmentDir() {
   }
 
   /**
+   * Sets environment directory.
    * @param value Directory with environment definitions. Filename without extension = environment name.
    * @return this
    */
@@ -154,6 +159,7 @@ public File getDestDir() {
   }
 
   /**
+   * Sets destination directory.
    * @param value Destination directory for generated file.
    * @return this
    */
@@ -171,6 +177,7 @@ public boolean isDeleteBeforeGenerate() {
   }
 
   /**
+   * Sets delete before generate flag.
    * @param value Delete before generate
    * @return this
    */
@@ -188,6 +195,7 @@ public String getVersion() {
   }
 
   /**
+   * Sets version.
    * @param value Version
    * @return this
    */
@@ -205,6 +213,7 @@ public boolean isAllowSymlinks() {
   }
 
   /**
+   * Sets allow symlinks flag.
    * @param value Allow symlinks
    * @return this
    */
@@ -222,6 +231,7 @@ public ModelExport getModelExport() {
   }
 
   /**
+   * Sets model export.
    * @param value Model export
    * @return this
    */
@@ -231,6 +241,7 @@ public GeneratorOptions modelExport(ModelExport value) {
   }
 
   /**
+   * Gets value provider configuration.
    * @return Configuration for value providers.
    *         The outer map uses the value provider plugin name as key, the inner map contain the config properties.
    */
@@ -239,6 +250,7 @@ public Map<String, Map<String, Object>> getValueProviderConfig() {
   }
 
   /**
+   * Sets value provider configuration.
    * @param value Configuration for value providers.
    * @return this
    */
@@ -248,13 +260,15 @@ public GeneratorOptions valueProviderConfig(Map<String, Map<String, Object>> val
   }
 
   /**
+   * Gets generic plugin configuration.
    * @return Generic plugin configuration.
    */
   public Map<String, Map<String, Object>> getGenericPluginConfig() {
     return this.genericPluginConfig;
   }
 
   /**
+   * Sets generic plugin configuration.
    * @param value Generic plugin configuration.
    * @return this
    */
@@ -272,6 +286,7 @@ public Object getContainerContext() {
   }
 
   /**
+   * Sets container context.
    * @param value Container-specific context object
    * @return this
    */
@@ -281,13 +296,15 @@ public GeneratorOptions containerContext(Object value) {
   }
 
   /**
+   * Gets container classpath URLs.
    * @return List of classpath URLs to CONGA artifact dependencies and container classpath elements.
    */
   public List<URL> getContainerClasspathUrls() {
     return this.containerClasspathUrls;
   }
 
   /**
+   * Sets container classpath URLs.
    * @param value List of URLs to CONGA artifact dependencies defined in the container.
    * @return this
    */
@@ -297,13 +314,15 @@ public GeneratorOptions containerClasspathUrls(List<URL> value) {
   }
 
   /**
+   * Gets plugin manager.
    * @return Plugin manager
    */
   public PluginManager getPluginManager() {
     return this.pluginManager;
   }
 
   /**
+   * Sets plugin manager.
    * @param value Plugin manager
    * @return this
    */
@@ -313,13 +332,15 @@ public GeneratorOptions pluginManager(PluginManager value) {
   }
 
   /**
+   * Gets dependency version builder.
    * @return Function to build a list of dependency versions for a given environment
    */
   public Function<Environment, Collection<String>> getDependencyVersionBuilder() {
     return this.dependencyVersionBuilder;
   }
 
   /**
+   * Sets dependency version builder.
    * @param value Function to build a list of dependency versions for a given environment
    * @return this
    */
@@ -329,13 +350,15 @@ public GeneratorOptions dependencyVersionBuilder(Function<Environment, Collectio
   }
 
   /**
+   * Gets container version info.
    * @return Version information from container, e.g. configured Maven plugin versions
    */
   public Map<String, String> getContainerVersionInfo() {
     return this.containerVersionInfo;
   }
 
   /**
+   * Sets container version info.
    * @param value Version information from container, e.g. configured Maven plugin versions
    * @return this
    */
@@ -345,13 +368,15 @@ public GeneratorOptions containerVersionInfo(Map<String, String> value) {
   }
 
   /**
+   * Gets logger.
    * @return Logger
    */
   public Logger getLogger() {
     return this.logger;
   }
 
   /**
+   * Sets logger.
    * @param value Logger
    * @return this
    */

generator/src/main/java/io/wcm/devops/conga/generator/UrlFileManager.java

@@ -45,6 +45,7 @@ public final class UrlFileManager {
   private static final Pattern URL_WITH_PREFIX = Pattern.compile("^[a-zA-Z]+:.*$");
 
   /**
+   * Constructor.
    * @param pluginManager Plugin manager
    * @param context URL file plugin context
    */

generator/src/main/java/io/wcm/devops/conga/generator/export/NodeModelExport.java

@@ -59,6 +59,7 @@ public final class NodeModelExport {
   private final List<ExportNodeRoleData> roleData = new ArrayList<>();
 
   /**
+   * Constructor.
    * @param nodeDir Target directory for node
    * @param node Node
    * @param environment Environment

generator/src/main/java/io/wcm/devops/conga/generator/handlebars/CharsetAwareTemplateLoader.java

@@ -38,6 +38,7 @@ public class CharsetAwareTemplateLoader extends AbstractTemplateLoader {
   private final String charset;
 
   /**
+   * Constructor.
    * @param templateDirs Template base directories
    * @param charset Charset for reading template files
    */

generator/src/main/java/io/wcm/devops/conga/generator/handlebars/HandlebarsManager.java

@@ -83,6 +83,7 @@ public Object apply(Object context, Options helperOptions) throws IOException {
       });
 
   /**
+   * Constructor.
    * @param templateDirs Template base directories
    * @param pluginContextOptions Plugin context options
    */

generator/src/main/java/io/wcm/devops/conga/generator/plugins/fileheader/AbstractFileHeader.java

@@ -78,30 +78,60 @@ public final Void apply(FileContext file, FileHeaderContext context) {
     return null;
   }
 
+  /**
+   * Sanitizes comment line.
+   * @param line Comment line
+   * @return Sanitized comment line
+   */
   protected String sanitizeComment(String line) {
     return line;
   }
 
+  /**
+   * Gets line break character(s).
+   * @return Line break character(s)
+   */
   protected String getLineBreak() {
     return "\n";
   }
 
+  /**
+   * Gets comment block start.
+   * @return Comment block start string
+   */
   protected String getCommentBlockStart() {
     return null;
   }
 
+  /**
+   * Gets comment block end.
+   * @return Comment block end string
+   */
   protected String getCommentBlockEnd() {
     return null;
   }
 
+  /**
+   * Gets comment line prefix.
+   * @return Comment line prefix string
+   */
   protected String getCommentLinePrefix() {
     return null;
   }
 
+  /**
+   * Gets block suffix.
+   * @return Block suffix string
+   */
   protected String getBlockSuffix() {
     return null;
   }
 
+  /**
+   * Gets insert position for file header.
+   * @param content File content
+   * @return Insert position
+   */
   protected int getInsertPosition(@SuppressWarnings({ "unused", "java:S1172" }) String content) {
     return 0;
   }

generator/src/main/java/io/wcm/devops/conga/generator/spi/Plugin.java

@@ -25,6 +25,7 @@
 public interface Plugin {
 
   /**
+   * Gets plugin name.
    * @return Plugin name to be referenced in definition file
    */
   String getName();

generator/src/main/java/io/wcm/devops/conga/generator/spi/ValidationException.java

@@ -26,13 +26,15 @@ public final class ValidationException extends RuntimeException {
   private static final long serialVersionUID = 1L;
 
   /**
+   * Constructor.
    * @param message Message
    */
   public ValidationException(String message) {
     super(message);
   }
 
   /**
+   * Constructor.
    * @param message Message
    * @param cause Cause
    */