Add some javadoc to the Sonar Markdown module

diff --git a/sonar-markdown/src/main/java/org/sonar/markdown/HtmlCodeChannel.java b/sonar-markdown/src/main/java/org/sonar/markdown/HtmlCodeChannel.java
index 4fd5d3fd11cea6f8383ba7eda0b3510376d0bf01..b2601557b34a2265d38d01a1acb4145ef20fd6d1 100644 (file)
--- a/sonar-markdown/src/main/java/org/sonar/markdown/HtmlCodeChannel.java
+++ b/sonar-markdown/src/main/java/org/sonar/markdown/HtmlCodeChannel.java
@@ -21,6 +21,11 @@ package org.sonar.markdown;
 
 import org.sonar.channel.RegexChannel;
 
+/**
+ * Markdown treats double simple quotes ('') as indicators of code. Text wrapped with two '' will be wrapped with an HTML <code> tag.
+ * 
+ * E.g., the input ''printf()'' will produce <code>printf()</code>
+ */
 class HtmlCodeChannel extends RegexChannel<MarkdownOutput> {
 
   public HtmlCodeChannel() {

diff --git a/sonar-markdown/src/main/java/org/sonar/markdown/HtmlEmphasisChannel.java b/sonar-markdown/src/main/java/org/sonar/markdown/HtmlEmphasisChannel.java
index ffaf0ac60e70231a68e11039bb7115c5cf2c8660..bb53dd8a43ead83b70781523072b7667defe1e69 100644 (file)
--- a/sonar-markdown/src/main/java/org/sonar/markdown/HtmlEmphasisChannel.java
+++ b/sonar-markdown/src/main/java/org/sonar/markdown/HtmlEmphasisChannel.java
@@ -21,6 +21,11 @@ package org.sonar.markdown;
 
 import org.sonar.channel.RegexChannel;
 
+/**
+ * Markdown treats asterisks (*) as indicators of emphasis. Text wrapped with one * will be wrapped with an HTML <em> tag.
+ * 
+ * E.g., the input *word* will produce <em>work</word>
+ */
 class HtmlEmphasisChannel extends RegexChannel<MarkdownOutput> {
 
   public HtmlEmphasisChannel() {

diff --git a/sonar-markdown/src/main/java/org/sonar/markdown/HtmlEndOfLineChannel.java b/sonar-markdown/src/main/java/org/sonar/markdown/HtmlEndOfLineChannel.java
index d7ed7afcdbd5186086df79eec87cbb2ab4b5034a..e990b0a9584702aec89af489f1ea937f8a278df1 100644 (file)
--- a/sonar-markdown/src/main/java/org/sonar/markdown/HtmlEndOfLineChannel.java
+++ b/sonar-markdown/src/main/java/org/sonar/markdown/HtmlEndOfLineChannel.java
@@ -21,6 +21,11 @@ package org.sonar.markdown;
 
 import org.sonar.channel.RegexChannel;
 
+/**
+ * Markdown replace any line return by an HTML <br/>
+ * tag.
+ * 
+ */
 class HtmlEndOfLineChannel extends RegexChannel<MarkdownOutput> {
 
   public HtmlEndOfLineChannel() {

diff --git a/sonar-markdown/src/main/java/org/sonar/markdown/HtmlUrlChannel.java b/sonar-markdown/src/main/java/org/sonar/markdown/HtmlUrlChannel.java
index 14933ca029a4b0901e57dd03fa5955d3ae2b8978..7080a6abe3fb97460fb69c0b398ab47d1d6a5efb 100644 (file)
--- a/sonar-markdown/src/main/java/org/sonar/markdown/HtmlUrlChannel.java
+++ b/sonar-markdown/src/main/java/org/sonar/markdown/HtmlUrlChannel.java
@@ -21,6 +21,10 @@ package org.sonar.markdown;
 
 import org.sonar.channel.RegexChannel;
 
+/**
+ * Markdown will wrap any URL with an HTML <a href="URL"> tag.
+ * 
+ */
 class HtmlUrlChannel extends RegexChannel<MarkdownOutput> {
 
   public HtmlUrlChannel() {
@@ -29,6 +33,6 @@ class HtmlUrlChannel extends RegexChannel<MarkdownOutput> {
 
   @Override
   protected void consume(CharSequence token, MarkdownOutput output) {
-    output.append("<a href=\"" +token + "\">" + token + "</a>");
+    output.append("<a href=\"" + token + "\">" + token + "</a>");
   }
 }

diff --git a/sonar-markdown/src/main/java/org/sonar/markdown/IdentifierAndNumberChannel.java b/sonar-markdown/src/main/java/org/sonar/markdown/IdentifierAndNumberChannel.java
index 74b8dffb3b3810d7e7676e8b51748308a83f339c..126f99d6013ae35f6da32fe981693188815260dd 100644 (file)
--- a/sonar-markdown/src/main/java/org/sonar/markdown/IdentifierAndNumberChannel.java
+++ b/sonar-markdown/src/main/java/org/sonar/markdown/IdentifierAndNumberChannel.java
@@ -21,6 +21,9 @@ package org.sonar.markdown;
 
 import org.sonar.channel.RegexChannel;
 
+/**
+ * Channel used only to improve performances of the Markdown engine by consuming any sequence of letter or digit.
+ */
 class IdentifierAndNumberChannel extends RegexChannel<MarkdownOutput> {
 
   public IdentifierAndNumberChannel() {

diff --git a/sonar-markdown/src/main/java/org/sonar/markdown/MarkdownEngine.java b/sonar-markdown/src/main/java/org/sonar/markdown/MarkdownEngine.java
index 6a7f84dd7d451d904f909ab73ba6781f770271dc..773126ac166935f461d0e86bd184f510e2489675 100644 (file)
--- a/sonar-markdown/src/main/java/org/sonar/markdown/MarkdownEngine.java
+++ b/sonar-markdown/src/main/java/org/sonar/markdown/MarkdownEngine.java
@@ -26,6 +26,9 @@ import org.sonar.channel.Channel;
 import org.sonar.channel.ChannelDispatcher;
 import org.sonar.channel.CodeReader;
 
+/**
+ * Entry point of the Markdown library
+ */
 public class MarkdownEngine {
 
   private MarkdownOutput output;

diff --git a/sonar-markdown/src/main/java/org/sonar/markdown/package-info.java b/sonar-markdown/src/main/java/org/sonar/markdown/package-info.java
new file mode 100644 (file)
index 0000000..b31bf27
--- /dev/null
+++ b/sonar-markdown/src/main/java/org/sonar/markdown/package-info.java
@@ -0,0 +1,25 @@
+/*
+ * Sonar, open source software quality management tool.
+ * Copyright (C) 2008-2011 SonarSource
+ * mailto:contact AT sonarsource DOT com
+ *
+ * Sonar is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * Sonar is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with Sonar; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
+ */
+/**
+ * Basic implementation of the Markdown markup language (see http://en.wikipedia.org/wiki/Markdown)
+ * 
+ */
+package org.sonar.markdown;
+