Add missing Javadoc comments to metafacture-fix methods/constructors. (#577)

Author: blackwinter

config/checkstyle/checkstyle.xml

@@ -13,7 +13,7 @@
         <property name="files" value="xtext-gen"/>
     </module>
     <module name="SuppressionSingleFilter">
-        <property name="checks" value="MultipleStringLiterals|ExecutableStatementCount|MagicNumber"/>
+        <property name="checks" value="ExecutableStatementCount|MagicNumber|MissingJavadocMethod|MultipleStringLiterals"/>
         <property name="files" value="test"/>
     </module>
     <module name="TreeWalker">
@@ -93,7 +93,7 @@
         <module name="MethodTypeParameterName"/>
         <module name="MissingCtor"/>
         <module name="MissingDeprecated"/>
-        <!--<module name="MissingJavadocMethod"/>-->
+        <module name="MissingJavadocMethod"/>
         <module name="MissingOverride"/>
         <module name="MissingSwitchDefault"/>
         <module name="ModifiedControlVariable"/>

metafix-ide/src/main/java/org/metafacture/metafix/ide/FixIdeModule.java

@@ -4,6 +4,11 @@
  * Use this class to register ide components.
  */
 public class FixIdeModule extends AbstractFixIdeModule {
+
+    /**
+     * Creates an instance of {@link FixIdeModule}.
+     */
     public FixIdeModule() {
     }
+
 }

metafix-ide/src/main/java/org/metafacture/metafix/ide/FixIdeSetup.java

@@ -12,6 +12,9 @@
  */
 public class FixIdeSetup extends FixStandaloneSetup {
 
+    /**
+     * Creates an instance of {@link FixIdeSetup}.
+     */
     public FixIdeSetup() {
     }
 

metafix-web/src/main/java/org/metafacture/metafix/web/FixServlet.java

@@ -33,6 +33,9 @@ public class FixServlet extends XtextServlet {
 
     private DisposableRegistry disposableRegistry;
 
+    /**
+     * Creates an instance of {@link FixServlet}.
+     */
     public FixServlet() {
     }
 

metafix-web/src/main/java/org/metafacture/metafix/web/FixWebModule.java

@@ -5,6 +5,11 @@
  * application.
  */
 public class FixWebModule extends AbstractFixWebModule {
+
+    /**
+     * Creates an instance of {@link FixWebModule}.
+     */
     public FixWebModule() {
     }
+
 }

metafix-web/src/main/java/org/metafacture/metafix/web/FixWebSetup.java

@@ -13,6 +13,9 @@
  */
 public class FixWebSetup extends FixStandaloneSetup {
 
+    /**
+     * Creates an instance of {@link FixWebSetup}.
+     */
     public FixWebSetup() {
     }
 

metafix-web/src/main/java/org/metafacture/metafix/web/ServerLauncher.java

@@ -22,6 +22,11 @@ private ServerLauncher() {
         throw new IllegalAccessError("Utility class");
     }
 
+    /**
+     * Starts an HTTP server for testing the web integration of your DSL.
+     *
+     * @param args unused
+     */
     public static void main(final String[] args) {
         final WebAppContext context = new WebAppContext();
         context.setResourceBase("src/main/webapp");

metafix/src/jmh/java/org/metafacture/metafix/AbstractBenchmark.java

@@ -42,9 +42,15 @@
 @State(Scope.Thread)
 public abstract class AbstractBenchmark {
 
+    /**
+     * Creates an instance of {@link AbstractBenchmark}.
+     */
     public AbstractBenchmark() {
     }
 
+    /**
+     * Performs the benchmark.
+     */
     @Benchmark
     public void benchmark() {
         workload();

metafix/src/jmh/java/org/metafacture/metafix/BaselineBenchmark.java

@@ -23,6 +23,9 @@
 @OutputTimeUnit(TimeUnit.MICROSECONDS)
 public class BaselineBenchmark extends AbstractBenchmark {
 
+    /**
+     * Creates an instance of {@link BaselineBenchmark}.
+     */
     public BaselineBenchmark() {
     }
 

metafix/src/jmh/java/org/metafacture/metafix/FixParseBenchmark.java

@@ -32,9 +32,15 @@ public class FixParseBenchmark extends AbstractBenchmark {
     })
     private String fixDef;
 
+    /**
+     * Creates an instance of {@link FixParseBenchmark}.
+     */
     public FixParseBenchmark() {
     }
 
+    /**
+     * Performs the setup.
+     */
     @Setup
     public void setup() {
         fixFile = String.format(FIXES, fixDef);