Apache
/
commons-lang
mirror of https://github.com/apache/commons-lang.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Cannot use {@code} to enclose text that includes {} 

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/lang/trunk@1079418 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Sebastian Bazley 2011-03-08 16:29:48 +00:00
parent 685075984b
commit ffb2308e76
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/main/java/org/apache/commons/lang3/ArrayUtils.java
View File

@ -137,7 +137,7 @@ public class ArrayUtils {
/** /**
* <p>ArrayUtils instances should NOT be constructed in standard programming. * <p>ArrayUtils instances should NOT be constructed in standard programming.
* Instead, the class should be used as {@code ArrayUtils.clone(new int[] {2})}.</p> * Instead, the class should be used as <code>ArrayUtils.clone(new int[] {2})</code>.</p>
* *
* <p>This constructor is public to permit tools that require a JavaBean instance * <p>This constructor is public to permit tools that require a JavaBean instance
* to operate.</p> * to operate.</p>
@ -146,6 +146,10 @@ public class ArrayUtils {
super(); super();
} }
// N.B. Cannot use {@code} to enclose text which includes {}, but <code></code> is OK
// Basic methods handling multi-dimensional arrays // Basic methods handling multi-dimensional arrays
//----------------------------------------------------------------------- //-----------------------------------------------------------------------
/** /**
@ -154,7 +158,7 @@ public class ArrayUtils {
* <p>Multi-dimensional arrays are handled correctly, including * <p>Multi-dimensional arrays are handled correctly, including
* multi-dimensional primitive arrays.</p> * multi-dimensional primitive arrays.</p>
* *
* <p>The format is that of Java source code, for example {@code {a,b}}.</p> * <p>The format is that of Java source code, for example <code>{a,b}</code>.</p>
* *
* @param array the array to get a toString for, may be {@code null} * @param array the array to get a toString for, may be {@code null}
* @return a String representation of the array, '{}' if null array input * @return a String representation of the array, '{}' if null array input
@ -169,7 +173,7 @@ public class ArrayUtils {
* <p>Multi-dimensional arrays are handled correctly, including * <p>Multi-dimensional arrays are handled correctly, including
* multi-dimensional primitive arrays.</p> * multi-dimensional primitive arrays.</p>
* *
* <p>The format is that of Java source code, for example {@code {a,b}}.</p> * <p>The format is that of Java source code, for example <code>{a,b}</code>.</p>
* *
* @param array the array to get a toString for, may be {@code null} * @param array the array to get a toString for, may be {@code null}
* @param stringIfNull the String to return if the array is {@code null} * @param stringIfNull the String to return if the array is {@code null}
@ -294,7 +298,7 @@ public class ArrayUtils {
* type explicitly like in * type explicitly like in
* <code>Number[] array = ArrayUtils.&lt;Number&gt;toArray(new Integer(42), new Double(Math.PI))</code>, * <code>Number[] array = ArrayUtils.&lt;Number&gt;toArray(new Integer(42), new Double(Math.PI))</code>,
* there is no real advantage when compared to * there is no real advantage when compared to
* {@code new Number[] {new Integer(42), new Double(Math.PI)}}.</p> * <code>new Number[] {new Integer(42), new Double(Math.PI)}</code>.</p>
* *
* @param <T> the array's element type * @param <T> the array's element type
* @param items the varargs array items, null allowed * @param items the varargs array items, null allowed