提交 e9182f52 authored 作者: Thomas Mueller's avatar Thomas Mueller

javadocs

上级 6a29a44c
...@@ -58,7 +58,7 @@ public class FileUtils { ...@@ -58,7 +58,7 @@ public class FileUtils {
/** /**
* Get the absolute file path of a file in the user home directory. * Get the absolute file path of a file in the user home directory.
* *
* @param fileName * @param fileName the file name
* @return the absolute path * @return the absolute path
*/ */
public static String getFileInUserHome(String fileName) { public static String getFileInUserHome(String fileName) {
......
...@@ -29,7 +29,7 @@ public class MathUtils { ...@@ -29,7 +29,7 @@ public class MathUtils {
* in 16, and so on. * in 16, and so on.
* *
* @param x the value to be rounded * @param x the value to be rounded
* @param blockSizePowerOf2 * @param blockSizePowerOf2 the block size
* @return the rounded value * @return the rounded value
*/ */
public static int roundUp(int x, int blockSizePowerOf2) { public static int roundUp(int x, int blockSizePowerOf2) {
...@@ -43,7 +43,7 @@ public class MathUtils { ...@@ -43,7 +43,7 @@ public class MathUtils {
* in 16, and so on. * in 16, and so on.
* *
* @param x the value to be rounded * @param x the value to be rounded
* @param blockSizePowerOf2 * @param blockSizePowerOf2 the block size
* @return the rounded value * @return the rounded value
*/ */
public static long roundUpLong(long x, long blockSizePowerOf2) { public static long roundUpLong(long x, long blockSizePowerOf2) {
......
...@@ -85,6 +85,7 @@ public class ObjectArray { ...@@ -85,6 +85,7 @@ public class ObjectArray {
* Remove the object at the given index. * Remove the object at the given index.
* *
* @param index the index * @param index the index
* @return the removed object
*/ */
public Object remove(int index) { public Object remove(int index) {
// TODO performance: the app should (where possible) // TODO performance: the app should (where possible)
......
...@@ -575,8 +575,8 @@ public class StringUtils { ...@@ -575,8 +575,8 @@ public class StringUtils {
* Creates an XML attribute of the form name="value". * Creates an XML attribute of the form name="value".
* A single space is prepended to the name, * A single space is prepended to the name,
* so that multiple attributes can be concatenated. * so that multiple attributes can be concatenated.
* @param name * @param name the attribute name
* @param value * @param value the attribute value
* @return the attribute * @return the attribute
*/ */
public static String xmlAttr(String name, String value) { public static String xmlAttr(String name, String value) {
...@@ -640,7 +640,7 @@ public class StringUtils { ...@@ -640,7 +640,7 @@ public class StringUtils {
* If the data contains '--', it is converted to '- -'. * If the data contains '--', it is converted to '- -'.
* The data is indented with 4 spaces if it contains a newline character. * The data is indented with 4 spaces if it contains a newline character.
* *
* @param data * @param data the comment text
* @return <!-- data --> * @return <!-- data -->
*/ */
public static String xmlComment(String data) { public static String xmlComment(String data) {
...@@ -663,7 +663,8 @@ public class StringUtils { ...@@ -663,7 +663,8 @@ public class StringUtils {
/** /**
* Converts the data to a CDATA element. * Converts the data to a CDATA element.
* If the data contains ']]>', it is escaped as a text element. * If the data contains ']]>', it is escaped as a text element.
* @param data *
* @param data the text data
* @return <![CDATA[data]]> * @return <![CDATA[data]]>
*/ */
public static String xmlCData(String data) { public static String xmlCData(String data) {
...@@ -686,7 +687,7 @@ public class StringUtils { ...@@ -686,7 +687,7 @@ public class StringUtils {
/** /**
* Escapes an XML text element. * Escapes an XML text element.
* *
* @param text * @param text the text data
* @return the escaped text * @return the escaped text
*/ */
public static String xmlText(String text) { public static String xmlText(String text) {
......
Markdown 格式
0%
您添加了 0 到此讨论。请谨慎行事。
请先完成此评论的编辑!
注册 或者 后发表评论