Fix some javadoc generation errors

openweb-nl · Nov 14, 2017 · 43f40b5 · 43f40b5
1 parent 3e7ec5d
commit 43f40b5
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 3 deletions.
diff --git a/bootstrapgenerator/src/main/java/nl/openweb/hippo/groovy/Generator.java b/bootstrapgenerator/src/main/java/nl/openweb/hippo/groovy/Generator.java
@@ -100,7 +100,7 @@ public static List<File> getGroovyFiles(final File dir) {
     /**
      * Technically it's not just Annotations, it's all classes from the Annotations library
      * This is a convenience method.
-     * @return
+     * @return a list of the annotation classes
      */
     public static List<Class<?>> getAnnotationClasses() {
         return ANNOTATED_CLASSES;

diff --git a/bootstrapgenerator/src/main/java/nl/openweb/hippo/groovy/ScriptClassFactory.java b/bootstrapgenerator/src/main/java/nl/openweb/hippo/groovy/ScriptClassFactory.java
@@ -36,7 +36,6 @@ public class ScriptClassFactory {
      *
      * @param file the file to make a class representation of
      * @return a fake class with the Bootstrap and Updater annotations
-     * @throws IOException
      */
     public static ScriptClass getInterpretingClass(final File file) {
         return  getInterpretingClassStrippingCode(file);

diff --git a/bootstrapgenerator/src/main/java/nl/openweb/hippo/groovy/XmlGenerator.java b/bootstrapgenerator/src/main/java/nl/openweb/hippo/groovy/XmlGenerator.java
@@ -123,6 +123,8 @@ public static Property createProperty(final String name, final Object value, fin
      * @param targetDir         the target where the ecmExtensions from resources would be
      * @param scriptClasses             groovy files, need to be relative to the source path
      * @param updaterNamePrefix prefix for the initialize items nodes   @return Node object representing the hippoecm-extension to marshall to xml
+     *
+     * @return the Node object for the ecm-extensions
      */
     public static Node getEcmExtensionNode(final File sourcePath, final File targetDir, final List<ScriptClass> scriptClasses, final String updaterNamePrefix) {
         final List<Object> properties;

diff --git a/bootstrapgenerator/src/main/java/nl/openweb/hippo/groovy/YamlGenerator.java b/bootstrapgenerator/src/main/java/nl/openweb/hippo/groovy/YamlGenerator.java
@@ -123,9 +123,11 @@ public static String getUpdateScriptYamlFilename(final File basePath, final Scri
 
     /**
      * Generate hcm-action.yaml to reload updaters
-     *  @param sourcePath sourcepath of groovy files
+     * @param sourcePath sourcepath of groovy files
      * @param targetDir  the target where the ecmExtensions from resources would be
      * @param files      groovy files, need to be relative to the source path
+     *
+     * @throws IOException
      */
     public static String getHcmActionsList(final File sourcePath, final File targetDir, final List<ScriptClass> files) throws IOException {
         Map<Double, Map<String, String>> collect = files.stream().filter(script ->