diff --git a/src/main/java/com/github/rjeschke/txtmark/BlockEmitter.java b/src/main/java/com/github/rjeschke/txtmark/BlockEmitter.java index 946bacd..ae0965b 100644 --- a/src/main/java/com/github/rjeschke/txtmark/BlockEmitter.java +++ b/src/main/java/com/github/rjeschke/txtmark/BlockEmitter.java @@ -23,15 +23,15 @@ import java.util.List; * 
  * public void emitBlock(StringBuilder out, List<String> lines, String meta)
  * {
- *     out.append("<pre><code>");
+ *     out.append("<pre><code>");
  *     for(final String s : lines)
  *     {
- *         for(int i = 0; i < s.length(); i++)
+ *         for(int i = 0; i < s.length(); i++)
  *         {
  *             final char c = s.charAt(i);
  *             switch(c)
  *             {
- *             case '&':
+ *             case '&':
  *                 out.append("&amp;");
  *                 break;
  *             case '<':
@@ -47,13 +47,13 @@ import java.util.List;
  *         }
  *         out.append('\n');
  *     }
- *     out.append("</code></pre>\n");
+ *     out.append("</code></pre>\n");
  * }
  * 
  *
* * - * @author René Jeschke + * @author René Jeschke <rene_jeschke@yahoo.de> * @since 0.7 */ public interface BlockEmitter diff --git a/src/main/java/com/github/rjeschke/txtmark/Configuration.java b/src/main/java/com/github/rjeschke/txtmark/Configuration.java index 3acfdee..17984bb 100644 --- a/src/main/java/com/github/rjeschke/txtmark/Configuration.java +++ b/src/main/java/com/github/rjeschke/txtmark/Configuration.java @@ -18,7 +18,7 @@ package com.github.rjeschke.txtmark; /** * Txtmark configuration. * - * @author René Jeschke + * @author René Jeschke <rene_jeschke@yahoo.de> * @since 0.7 */ public class Configuration @@ -90,7 +90,7 @@ public class Configuration /** * Configuration builder. * - * @author René Jeschke + * @author René Jeschke <rene_jeschke@yahoo.de> * @since 0.7 */ public static class Builder diff --git a/src/main/java/com/github/rjeschke/txtmark/Decorator.java b/src/main/java/com/github/rjeschke/txtmark/Decorator.java index 03b1e1c..6a20d9c 100644 --- a/src/main/java/com/github/rjeschke/txtmark/Decorator.java +++ b/src/main/java/com/github/rjeschke/txtmark/Decorator.java @@ -18,7 +18,7 @@ package com.github.rjeschke.txtmark; /** * Decorator interface. * - * @author René Jeschke + * @author René Jeschke <rene_jeschke@yahoo.de> */ public interface Decorator { @@ -30,7 +30,7 @@ public interface Decorator *

* * 
-     * out.append("<p>");
+     * out.append("<p>");
      *
* * @param out @@ -46,7 +46,7 @@ public interface Decorator *

* * 
-     * out.append("</p>\n");
+     * out.append("</p>\n");
      *
* * @param out @@ -60,7 +60,7 @@ public interface Decorator * Default implementation is: * * 
-     * out.append("<blockquote>");
+     * out.append("<blockquote>");
      *
* * @param out @@ -76,7 +76,7 @@ public interface Decorator *

* * 
-     * out.append("</blockquote>\n");
+     * out.append("</blockquote>\n");
      *
* * @param out @@ -92,7 +92,7 @@ public interface Decorator *

* * 
-     * out.append("<pre><code>");
+     * out.append("<pre><code>");
      *
* * @param out @@ -108,7 +108,7 @@ public interface Decorator *

* * 
-     * out.append("</code></pre>\n");
+     * out.append("</code></pre>\n");
      *
* * @param out @@ -124,7 +124,7 @@ public interface Decorator *

* * 
-     * out.append("<code>");
+     * out.append("<code>");
      *
* * @param out @@ -140,7 +140,7 @@ public interface Decorator *

* * 
-     * out.append("</code>");
+     * out.append("</code>");
      *
* * @param out @@ -165,6 +165,8 @@ public interface Decorator * * @param out * The StringBuilder to write to. + * @param level + * The level to use. */ public void openHeadline(final StringBuilder out, int level); @@ -178,11 +180,13 @@ public interface Decorator * 
      *  out.append("</h");
      * out.append(level);
-     * out.append(">\n");
+     * out.append(">\n");
      *
* * @param out * The StringBuilder to write to. + * @param level + * The level to use. */ public void closeHeadline(final StringBuilder out, int level); @@ -194,7 +198,7 @@ public interface Decorator *

* * 
-     * out.append("<strong>");
+     * out.append("<strong>");
      *
* * @param out @@ -210,7 +214,7 @@ public interface Decorator *

* * 
-     * out.append("</strong>");
+     * out.append("</strong>");
      *
* * @param out @@ -226,7 +230,7 @@ public interface Decorator *

* * 
-     * out.append("<em>");
+     * out.append("<em>");
      *
* * @param out @@ -242,7 +246,7 @@ public interface Decorator *

* * 
-     * out.append("</em>");
+     * out.append("</em>");
      *
* * @param out @@ -258,7 +262,7 @@ public interface Decorator *

* * 
-     * out.append("<sup>");
+     * out.append("<sup>");
      *
* * @param out @@ -274,7 +278,7 @@ public interface Decorator *

* * 
-     * out.append("</sup>");
+     * out.append("</sup>");
      *
* * @param out @@ -290,7 +294,7 @@ public interface Decorator *

* * 
-     * out.append("<ol>\n");
+     * out.append("<ol>\n");
      *
* * @param out @@ -306,7 +310,7 @@ public interface Decorator *

* * 
-     * out.append("</ol>\n");
+     * out.append("</ol>\n");
      *
* * @param out @@ -322,7 +326,7 @@ public interface Decorator *

* * 
-     * out.append("<ul>\n");
+     * out.append("<ul>\n");
      *
* * @param out @@ -338,7 +342,7 @@ public interface Decorator *

* * 
-     * out.append("</ul>\n");
+     * out.append("</ul>\n");
      *
* * @param out @@ -373,7 +377,7 @@ public interface Decorator *

* * 
-     * out.append("</li>\n");
+     * out.append("</li>\n");
      *
* * @param out @@ -389,7 +393,7 @@ public interface Decorator *

* * 
-     * out.append("<hr />\n");
+     * out.append("<hr />\n");
      *
* * @param out diff --git a/src/main/java/com/github/rjeschke/txtmark/DefaultDecorator.java b/src/main/java/com/github/rjeschke/txtmark/DefaultDecorator.java index ab7ea05..8d1956a 100644 --- a/src/main/java/com/github/rjeschke/txtmark/DefaultDecorator.java +++ b/src/main/java/com/github/rjeschke/txtmark/DefaultDecorator.java @@ -19,7 +19,7 @@ package com.github.rjeschke.txtmark; * Default Decorator implementation. * *

- * Example for a user Decorator having a class attribute on <p> tags. + * Example for a user Decorator having a class attribute on <p> tags. *

* * 
@@ -28,13 +28,13 @@ package com.github.rjeschke.txtmark;
  *     @Override
  *     public void openParagraph(StringBuilder out)
  *     {
- *         out.append("<p class=\"myclass\">");
+ *         out.append("<p class=\"myclass\">");
  *     }
  * }
  * 
  *
* - * @author René Jeschke + * @author René Jeschke <rene_jeschke@yahoo.de> */ public class DefaultDecorator implements Decorator { diff --git a/src/main/java/com/github/rjeschke/txtmark/Processor.java b/src/main/java/com/github/rjeschke/txtmark/Processor.java index 64fb34b..01993e6 100644 --- a/src/main/java/com/github/rjeschke/txtmark/Processor.java +++ b/src/main/java/com/github/rjeschke/txtmark/Processor.java @@ -36,7 +36,7 @@ import java.io.StringReader; * * * - * @author René Jeschke + * @author René Jeschke <rene_jeschke@yahoo.de> */ public class Processor { @@ -110,8 +110,8 @@ public class Processor /** * Transforms an input file into HTML using the given Configuration. * - * @param file - * The File to process. + * @param file The File to process. + * @param configuration the Configuration * @return The processed String. * @throws IOException * if an IO error occurs diff --git a/src/main/java/com/github/rjeschke/txtmark/Run.java b/src/main/java/com/github/rjeschke/txtmark/Run.java index 0724273..756d23c 100644 --- a/src/main/java/com/github/rjeschke/txtmark/Run.java +++ b/src/main/java/com/github/rjeschke/txtmark/Run.java @@ -43,24 +43,24 @@ import java.io.InputStreamReader; *

* * 
- * <?xml version="1.0" encoding="UTF-8"?>
+ * <?xml version="1.0" encoding="UTF-8"?>
  * <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
- *                       "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
- * <html xmlns="http://www.w3.org/1999/xhtml">
- * <head>
- * <title>markdown</title>
- * <link type="text/css" href="style.css" rel="stylesheet"/>
- * <meta http-equiv="content-type" content="text/html; charset=UTF-8"/>
- * </head>
- * <body>
- * <!-- the following line separates header from footer -->
- * <!-- ### -->
- * </body>
- * </html>
+ *                       "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+ * <html xmlns="http://www.w3.org/1999/xhtml">
+ * <head>
+ * <title>markdown</title>
+ * <link type="text/css" href="style.css" rel="stylesheet"/>
+ * <meta http-equiv="content-type" content="text/html; charset=UTF-8"/>
+ * </head>
+ * <body>
+ * <!-- the following line separates header from footer -->
+ * <!-- ### -->
+ * </body>
+ * </html>
  * 
  *
* - * @author René Jeschke + * @author René Jeschke <rene_jeschke@yahoo.de> */ public class Run {