Repository: incubator-groovy
Updated Branches:
  refs/heads/master adfefc362 -> 5a7afe389


escaped more less-than and greater-than signs in Javadoc (closes #57)


Project: http://git-wip-us.apache.org/repos/asf/incubator-groovy/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-groovy/commit/5a7afe38
Tree: http://git-wip-us.apache.org/repos/asf/incubator-groovy/tree/5a7afe38
Diff: http://git-wip-us.apache.org/repos/asf/incubator-groovy/diff/5a7afe38

Branch: refs/heads/master
Commit: 5a7afe389fd38bc83965651aafe46cc9f9dabbb2
Parents: adfefc3
Author: Keegan Witt <keeganw...@gmail.com>
Authored: Tue Jul 7 13:30:29 2015 -0400
Committer: pascalschumacher <pascalschumac...@gmx.net>
Committed: Tue Jul 7 20:21:40 2015 +0200

----------------------------------------------------------------------
 src/main/groovy/lang/EmptyRange.java                      |  2 +-
 src/main/groovy/lang/MetaClassImpl.java                   |  2 +-
 .../org/codehaus/groovy/runtime/DefaultGroovyMethods.java |  4 ++--
 .../groovy/runtime/metaclass/ConcurrentReaderHashMap.java |  4 ++--
 .../sc/transformers/StaticCompilationTransformer.java     |  2 +-
 .../groovy/transform/stc/StaticTypeCheckingSupport.java   |  8 ++++----
 .../groovy/transform/stc/StaticTypeCheckingVisitor.java   |  2 +-
 src/main/org/codehaus/groovy/vmplugin/VMPlugin.java       |  2 +-
 .../src/main/groovy/groovy/swing/impl/TableLayout.java    |  2 +-
 .../main/groovy/groovy/text/GStringTemplateEngine.java    | 10 ++++++----
 .../src/main/groovy/groovy/text/SimpleTemplateEngine.java |  2 +-
 .../main/groovy/groovy/text/StreamingTemplateEngine.java  |  4 ++--
 .../src/main/java/groovy/util/GroovyTestCase.java         |  2 +-
 .../src/main/java/groovy/util/XmlNodePrinter.java         |  2 +-
 .../src/main/java/groovy/xml/MarkupBuilder.java           |  2 +-
 15 files changed, 26 insertions(+), 24 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-groovy/blob/5a7afe38/src/main/groovy/lang/EmptyRange.java
----------------------------------------------------------------------
diff --git a/src/main/groovy/lang/EmptyRange.java 
b/src/main/groovy/lang/EmptyRange.java
index 1a69cf1..1680809 100644
--- a/src/main/groovy/lang/EmptyRange.java
+++ b/src/main/groovy/lang/EmptyRange.java
@@ -23,7 +23,7 @@ import org.codehaus.groovy.runtime.InvokerHelper;
 import java.util.*;
 
 /**
- * Constructing Ranges like 0..<0
+ * Constructing Ranges like 0..&lt;0
  * @author Dierk Koenig
  * @author Edwin Tellman
  */

http://git-wip-us.apache.org/repos/asf/incubator-groovy/blob/5a7afe38/src/main/groovy/lang/MetaClassImpl.java
----------------------------------------------------------------------
diff --git a/src/main/groovy/lang/MetaClassImpl.java 
b/src/main/groovy/lang/MetaClassImpl.java
index 3a7001b..efaea1c 100644
--- a/src/main/groovy/lang/MetaClassImpl.java
+++ b/src/main/groovy/lang/MetaClassImpl.java
@@ -2113,7 +2113,7 @@ public class MetaClassImpl implements MetaClass, 
MutableMetaClass {
 
     /**
      * return null if nothing valid has been found, a MetaMethod (for getter 
always the case if not null) or
-     * a LinkedList<MetaMethod> if there are multiple setter
+     * a LinkedList&lt;MetaMethod&gt; if there are multiple setter
      */
     private Object filterPropertyMethod(Object methodOrList, boolean isGetter, 
boolean booleanGetter) {
         // Method has been optimized to reach a target of 325 bytecode size, 
making it JIT'able

http://git-wip-us.apache.org/repos/asf/incubator-groovy/blob/5a7afe38/src/main/org/codehaus/groovy/runtime/DefaultGroovyMethods.java
----------------------------------------------------------------------
diff --git a/src/main/org/codehaus/groovy/runtime/DefaultGroovyMethods.java 
b/src/main/org/codehaus/groovy/runtime/DefaultGroovyMethods.java
index b8d6c23..8bdf932 100644
--- a/src/main/org/codehaus/groovy/runtime/DefaultGroovyMethods.java
+++ b/src/main/org/codehaus/groovy/runtime/DefaultGroovyMethods.java
@@ -7140,7 +7140,7 @@ public class DefaultGroovyMethods extends 
DefaultGroovyMethodsSupport {
      * </pre>
      *
      * @param self an Iterator
-     * @param idx  an index value (-self.size() <= idx < self.size())
+     * @param idx  an index value (-self.size() &lt;= idx &lt; self.size())
      * @return the value at the given index (after normalisation) or null if 
no corresponding value was found
      * @since 1.7.2
      */
@@ -7183,7 +7183,7 @@ public class DefaultGroovyMethods extends 
DefaultGroovyMethodsSupport {
      * </pre>
      *
      * @param self an Iterable
-     * @param idx  an index value (-self.size() <= idx < self.size()) but 
using -ve index values will be inefficient
+     * @param idx  an index value (-self.size() &lt;= idx &lt; self.size()) 
but using -ve index values will be inefficient
      * @return the value at the given index (after normalisation) or null if 
no corresponding value was found
      * @since 2.1.0
      */

http://git-wip-us.apache.org/repos/asf/incubator-groovy/blob/5a7afe38/src/main/org/codehaus/groovy/runtime/metaclass/ConcurrentReaderHashMap.java
----------------------------------------------------------------------
diff --git 
a/src/main/org/codehaus/groovy/runtime/metaclass/ConcurrentReaderHashMap.java 
b/src/main/org/codehaus/groovy/runtime/metaclass/ConcurrentReaderHashMap.java
index 44d1f83..216ba50 100644
--- 
a/src/main/org/codehaus/groovy/runtime/metaclass/ConcurrentReaderHashMap.java
+++ 
b/src/main/org/codehaus/groovy/runtime/metaclass/ConcurrentReaderHashMap.java
@@ -219,7 +219,7 @@ public class ConcurrentReaderHashMap
   /**
    * The maximum capacity, used if a higher value is implicitly specified
    * by either of the constructors with arguments.
-   * MUST be a power of two <= 1<<30.
+   * MUST be a power of two &lt;= 1&lt;&lt;30.
    */
   private static final int MAXIMUM_CAPACITY = 1 << 30;
   
@@ -1267,4 +1267,4 @@ public class ConcurrentReaderHashMap
   public float loadFactor() {
     return loadFactor;
   }
-}
\ No newline at end of file
+}

http://git-wip-us.apache.org/repos/asf/incubator-groovy/blob/5a7afe38/src/main/org/codehaus/groovy/transform/sc/transformers/StaticCompilationTransformer.java
----------------------------------------------------------------------
diff --git 
a/src/main/org/codehaus/groovy/transform/sc/transformers/StaticCompilationTransformer.java
 
b/src/main/org/codehaus/groovy/transform/sc/transformers/StaticCompilationTransformer.java
index 6242762..90c956c 100644
--- 
a/src/main/org/codehaus/groovy/transform/sc/transformers/StaticCompilationTransformer.java
+++ 
b/src/main/org/codehaus/groovy/transform/sc/transformers/StaticCompilationTransformer.java
@@ -47,7 +47,7 @@ import java.util.Iterator;
 import java.util.Map;
 
 /**
- * Some expressions use symbols as aliases to method calls (<<, +=, ...). In 
static compilation,
+ * Some expressions use symbols as aliases to method calls (&lt;&lt;, +=, 
...). In static compilation,
  * if such a method call is found, we transform the original binary expression 
into a method
  * call expression so that the call gets statically compiled.
  *

http://git-wip-us.apache.org/repos/asf/incubator-groovy/blob/5a7afe38/src/main/org/codehaus/groovy/transform/stc/StaticTypeCheckingSupport.java
----------------------------------------------------------------------
diff --git 
a/src/main/org/codehaus/groovy/transform/stc/StaticTypeCheckingSupport.java 
b/src/main/org/codehaus/groovy/transform/stc/StaticTypeCheckingSupport.java
index c82bcba..7e0aa4a 100644
--- a/src/main/org/codehaus/groovy/transform/stc/StaticTypeCheckingSupport.java
+++ b/src/main/org/codehaus/groovy/transform/stc/StaticTypeCheckingSupport.java
@@ -1588,13 +1588,13 @@ public abstract class StaticTypeCheckingSupport {
      * use supplied type to make a connection from usage to declaration
      * The method operates in two modes. 
      * * For type !instanceof target a structural compare will be done 
-     *   (for example Dummy<T> and List<R> to get T=R) 
+     *   (for example Dummy&lt;T&gt; and List&lt;R&gt; to get T=R)
      * * If type equals target, a structural match is done as well 
-     *   (for example Colection<U> and Collection<E> to get U=E)
+     *   (for example Colection&lt;U&gt; and Collection&lt;E&gt; to get U=E)
      * * otherwise we climb the hierarchy to find a case of type equals target
      *   to then execute the structural match, while applying possibly existing
-     *   generics contexts on the way (for example for IntRange and 
Collection<E>
-     *   to get E=Integer, since IntRange is an AbstractList<Integer>)
+     *   generics contexts on the way (for example for IntRange and 
Collection&lt;E&gt;
+     *   to get E=Integer, since IntRange is an AbstractList&lt;Integer&gt;)
      * Should the target not have any generics this method does nothing.
      */
     static void extractGenericsConnections(Map<String, GenericsType> 
connections, ClassNode type, ClassNode target) {

http://git-wip-us.apache.org/repos/asf/incubator-groovy/blob/5a7afe38/src/main/org/codehaus/groovy/transform/stc/StaticTypeCheckingVisitor.java
----------------------------------------------------------------------
diff --git 
a/src/main/org/codehaus/groovy/transform/stc/StaticTypeCheckingVisitor.java 
b/src/main/org/codehaus/groovy/transform/stc/StaticTypeCheckingVisitor.java
index 4a5dfba..b749df8 100644
--- a/src/main/org/codehaus/groovy/transform/stc/StaticTypeCheckingVisitor.java
+++ b/src/main/org/codehaus/groovy/transform/stc/StaticTypeCheckingVisitor.java
@@ -395,7 +395,7 @@ public class StaticTypeCheckingVisitor extends 
ClassCodeVisitorSupport {
     }
 
     /**
-     * wrap type in Class<> if usingClass==true
+     * wrap type in Class&lt;&gt; if usingClass==true
      */
     private ClassNode makeType(ClassNode cn, boolean usingClass) {
         if (usingClass) {

http://git-wip-us.apache.org/repos/asf/incubator-groovy/blob/5a7afe38/src/main/org/codehaus/groovy/vmplugin/VMPlugin.java
----------------------------------------------------------------------
diff --git a/src/main/org/codehaus/groovy/vmplugin/VMPlugin.java 
b/src/main/org/codehaus/groovy/vmplugin/VMPlugin.java
index a761a15..5702bb2 100644
--- a/src/main/org/codehaus/groovy/vmplugin/VMPlugin.java
+++ b/src/main/org/codehaus/groovy/vmplugin/VMPlugin.java
@@ -40,7 +40,7 @@ public interface VMPlugin {
      * This method will require at least Java 7, but since the source has to 
compile
      * on older Java versions as well it is not marked to return a 
MethodHandle and
      * uses Object instead
-     * @return  null in case of jdk<7, otherwise a handel that takes the 
method call
+     * @return  null in case of jdk&lt;7, otherwise a handel that takes the 
method call
      *          arguments for the invokespecial call
      */
     Object getInvokeSpecialHandle(Method m, Object receiver);

http://git-wip-us.apache.org/repos/asf/incubator-groovy/blob/5a7afe38/subprojects/groovy-swing/src/main/groovy/groovy/swing/impl/TableLayout.java
----------------------------------------------------------------------
diff --git 
a/subprojects/groovy-swing/src/main/groovy/groovy/swing/impl/TableLayout.java 
b/subprojects/groovy-swing/src/main/groovy/groovy/swing/impl/TableLayout.java
index 534d3ee..03e4de4 100644
--- 
a/subprojects/groovy-swing/src/main/groovy/groovy/swing/impl/TableLayout.java
+++ 
b/subprojects/groovy-swing/src/main/groovy/groovy/swing/impl/TableLayout.java
@@ -57,7 +57,7 @@ public class TableLayout extends JPanel {
     }
 
     /**
-     * Creates a new row index for child <tr> tags 
+     * Creates a new row index for child tr tags
      * @return nextRowIndex the row number
      */
     public int nextRowIndex() {

http://git-wip-us.apache.org/repos/asf/incubator-groovy/blob/5a7afe38/subprojects/groovy-templates/src/main/groovy/groovy/text/GStringTemplateEngine.java
----------------------------------------------------------------------
diff --git 
a/subprojects/groovy-templates/src/main/groovy/groovy/text/GStringTemplateEngine.java
 
b/subprojects/groovy-templates/src/main/groovy/groovy/text/GStringTemplateEngine.java
index c033dc4..9b2c4a1 100644
--- 
a/subprojects/groovy-templates/src/main/groovy/groovy/text/GStringTemplateEngine.java
+++ 
b/subprojects/groovy-templates/src/main/groovy/groovy/text/GStringTemplateEngine.java
@@ -120,12 +120,14 @@ public class GStringTemplateEngine extends TemplateEngine 
{
          * to the writer passed as a parameter
          * <p>
          * For example:
-         * <p>
+         * <pre>
          * '<%= "test" %> of expr and <% test = 1 %>${test} script.'
+         * </pre>
          * <p>
          * would compile into:
-         * <p>
+         * <pre>
          * { out -> out << "${"test"} of expr and "; test = 1 ; out << 
"${test} script."}.asWritable()
+         * </pre>
          *
          * @param reader
          * @param parentLoader
@@ -235,7 +237,7 @@ public class GStringTemplateEngine extends TemplateEngine {
         }
 
         /**
-         * Parse a <% .... %> section
+         * Parse a &lt;% .... %&gt; section
          * if we are writing a GString close and append ';'
          * then write the section as a statement
          *
@@ -270,7 +272,7 @@ public class GStringTemplateEngine extends TemplateEngine {
         }
 
         /**
-         * Parse a <%= .... %> expression
+         * Parse a &lt;%= .... %&gt; expression
          *
          * @param reader
          * @param writingString

http://git-wip-us.apache.org/repos/asf/incubator-groovy/blob/5a7afe38/subprojects/groovy-templates/src/main/groovy/groovy/text/SimpleTemplateEngine.java
----------------------------------------------------------------------
diff --git 
a/subprojects/groovy-templates/src/main/groovy/groovy/text/SimpleTemplateEngine.java
 
b/subprojects/groovy-templates/src/main/groovy/groovy/text/SimpleTemplateEngine.java
index 900bbe8..415f346 100644
--- 
a/subprojects/groovy-templates/src/main/groovy/groovy/text/SimpleTemplateEngine.java
+++ 
b/subprojects/groovy-templates/src/main/groovy/groovy/text/SimpleTemplateEngine.java
@@ -184,7 +184,7 @@ public class SimpleTemplateEngine extends TemplateEngine {
         }
 
         /**
-         * Parse the text document looking for <% or <%= and then call out to 
the appropriate handler, otherwise copy the text directly
+         * Parse the text document looking for &lt;% or &lt;%= and then call 
out to the appropriate handler, otherwise copy the text directly
          * into the script while escaping quotes.
          *
          * @param reader a reader for the template text

http://git-wip-us.apache.org/repos/asf/incubator-groovy/blob/5a7afe38/subprojects/groovy-templates/src/main/groovy/groovy/text/StreamingTemplateEngine.java
----------------------------------------------------------------------
diff --git 
a/subprojects/groovy-templates/src/main/groovy/groovy/text/StreamingTemplateEngine.java
 
b/subprojects/groovy-templates/src/main/groovy/groovy/text/StreamingTemplateEngine.java
index 21b7ca0..b7fb032 100644
--- 
a/subprojects/groovy-templates/src/main/groovy/groovy/text/StreamingTemplateEngine.java
+++ 
b/subprojects/groovy-templates/src/main/groovy/groovy/text/StreamingTemplateEngine.java
@@ -726,7 +726,7 @@ public class StreamingTemplateEngine extends TemplateEngine 
{
         }
 
         /**
-         * Parse a <% .... %> section if we are writing a GString close and
+         * Parse a &lt;% .... %&gt; section if we are writing a GString close 
and
          * append ';' then write the section as a statement
          */
         private void parseSection(final int pendingC,
@@ -754,7 +754,7 @@ public class StreamingTemplateEngine extends TemplateEngine 
{
         }
 
         /**
-         * Parse a <%= .... %> expression
+         * Parse a &lt;%= .... %&gt; expression
          */
         private void parseExpression(final Reader reader,
                 final StringBuilder target,

http://git-wip-us.apache.org/repos/asf/incubator-groovy/blob/5a7afe38/subprojects/groovy-test/src/main/java/groovy/util/GroovyTestCase.java
----------------------------------------------------------------------
diff --git 
a/subprojects/groovy-test/src/main/java/groovy/util/GroovyTestCase.java 
b/subprojects/groovy-test/src/main/java/groovy/util/GroovyTestCase.java
index f6fa406..a72d839 100644
--- a/subprojects/groovy-test/src/main/java/groovy/util/GroovyTestCase.java
+++ b/subprojects/groovy-test/src/main/java/groovy/util/GroovyTestCase.java
@@ -261,7 +261,7 @@ public class GroovyTestCase extends TestCase {
      * Convenience method for subclasses of GroovyTestCase, identical to
      * <pre> GroovyTestCase.notYetImplemented(this); </pre>.
      *
-     * @return <false> when not itself already in the call stack
+     * @return <code>false</code> when not itself already in the call stack
      * @see #notYetImplemented(java.lang.Object)
      */
     public boolean notYetImplemented() {

http://git-wip-us.apache.org/repos/asf/incubator-groovy/blob/5a7afe38/subprojects/groovy-xml/src/main/java/groovy/util/XmlNodePrinter.java
----------------------------------------------------------------------
diff --git 
a/subprojects/groovy-xml/src/main/java/groovy/util/XmlNodePrinter.java 
b/subprojects/groovy-xml/src/main/java/groovy/util/XmlNodePrinter.java
index 192753b..8501e42 100644
--- a/subprojects/groovy-xml/src/main/java/groovy/util/XmlNodePrinter.java
+++ b/subprojects/groovy-xml/src/main/java/groovy/util/XmlNodePrinter.java
@@ -153,7 +153,7 @@ public class XmlNodePrinter {
     }
 
     /**
-     * Whether empty elements are expanded from <tagName/> to 
<tagName></tagName>.
+     * Whether empty elements are expanded from &lt;tagName/&gt; to 
&lt;tagName&gt;&lt;/tagName&gt;.
      *
      * @param expandEmptyElements if <code>true</code>, empty
      *                            elements will be represented by an opening 
tag

http://git-wip-us.apache.org/repos/asf/incubator-groovy/blob/5a7afe38/subprojects/groovy-xml/src/main/java/groovy/xml/MarkupBuilder.java
----------------------------------------------------------------------
diff --git a/subprojects/groovy-xml/src/main/java/groovy/xml/MarkupBuilder.java 
b/subprojects/groovy-xml/src/main/java/groovy/xml/MarkupBuilder.java
index 8d26aa8..ae54ece 100644
--- a/subprojects/groovy-xml/src/main/java/groovy/xml/MarkupBuilder.java
+++ b/subprojects/groovy-xml/src/main/java/groovy/xml/MarkupBuilder.java
@@ -210,7 +210,7 @@ public class MarkupBuilder extends BuilderSupport {
     }
 
     /**
-     * Whether empty elements are expanded from <tagName/> to 
<tagName></tagName>.
+     * Whether empty elements are expanded from &lt;tagName/&gt; to 
&lt;tagName&gt;&lt;/tagName&gt;.
      *
      * @param expandEmptyElements if <code>true</code>, empty
      *                            elements will be represented by an opening 
tag

Reply via email to