From 233fc6db0ad119cd8dcb0cb3c0b39cfb49343689 Mon Sep 17 00:00:00 2001 From: mdb Date: Fri, 14 Jan 2005 15:54:33 +0000 Subject: [PATCH] Javadoc fixes. git-svn-id: https://samskivert.googlecode.com/svn/trunk@1571 6335cc39-0255-0410-8fd6-9bcaacd3b74c --- .../src/java/com/samskivert/jdbc/jora/Session.java | 7 ++++--- .../src/java/com/samskivert/jdbc/jora/Table.java | 10 +++++----- .../src/java/com/samskivert/text/MessageUtil.java | 8 +++++--- .../src/java/com/samskivert/util/CalendarUtil.java | 4 ++-- .../src/java/com/samskivert/util/ClassUtil.java | 4 ++-- .../java/com/samskivert/util/SortableArrayList.java | 1 + 6 files changed, 19 insertions(+), 15 deletions(-) diff --git a/projects/samskivert/src/java/com/samskivert/jdbc/jora/Session.java b/projects/samskivert/src/java/com/samskivert/jdbc/jora/Session.java index 7fe6598d..f90a4ef2 100644 --- a/projects/samskivert/src/java/com/samskivert/jdbc/jora/Session.java +++ b/projects/samskivert/src/java/com/samskivert/jdbc/jora/Session.java @@ -36,7 +36,7 @@ public class Session { /** Construct a session with a pre-existing connection instance. In * this case, {@link #open} should not be called on this session. * - * @param conn the connection to use. + * @param connection the connection to use. */ public Session(Connection connection) { @@ -102,9 +102,10 @@ public class Session { * The DriverManager attempts to select an appropriate driver from * the set of registered JDBC drivers. * - * @param url a database url of the form + * @param dataSource a database url of the form * jdbc:subprotocol:subname - * @param user the database user on whose behalf the Connection is being made + * @param user the database user on whose behalf the Connection is + * being made * @param password the user's password * @return true if session is succesfully openned, false otherwise */ diff --git a/projects/samskivert/src/java/com/samskivert/jdbc/jora/Table.java b/projects/samskivert/src/java/com/samskivert/jdbc/jora/Table.java index 5e19bf18..b2e392b5 100644 --- a/projects/samskivert/src/java/com/samskivert/jdbc/jora/Table.java +++ b/projects/samskivert/src/java/com/samskivert/jdbc/jora/Table.java @@ -25,7 +25,7 @@ public class Table { /** Constructor for table object. Make association between Java class * and database table. * - * @param tclassName name of Java class + * @param className name of Java class * @param tableName name of database table mapped on this Java class * @param s session, which should be opened before first access to the table * @param key table's primary key. This parameter is used in UPDATE/DELETE @@ -42,7 +42,7 @@ public class Table { /** Constructor for table object. Make association between Java class * and database table. * - * @param tclassName name of Java class + * @param className name of Java class * @param tableName name of database table mapped on this Java class * @param key table's primary key. This parameter is used in UPDATE/DELETE * operations to locate record in the table. @@ -56,7 +56,7 @@ public class Table { /** Constructor for table object. Make association between Java class * and database table. * - * @param tclassName name of Java class + * @param className name of Java class * @param tableName name of database table mapped on this Java class * @param keys table primary keys. This parameter is used in UPDATE/DELETE * operations to locate record in the table. @@ -70,9 +70,9 @@ public class Table { /** Constructor for table object. Make association between Java class * and database table. * - * @param tclassName name of Java class + * @param className name of Java class * @param tableName name of database table mapped on this Java class - * @param key table's primary key. This parameter is used in UPDATE/DELETE + * @param keys table primary keys. This parameter is used in UPDATE/DELETE * operations to locate record in the table. * @param s session, which should be opened before first access to the table * @param mixedCaseConvert whether or not to convert mixed case field diff --git a/projects/samskivert/src/java/com/samskivert/text/MessageUtil.java b/projects/samskivert/src/java/com/samskivert/text/MessageUtil.java index 9a41c016..dd9b5d08 100644 --- a/projects/samskivert/src/java/com/samskivert/text/MessageUtil.java +++ b/projects/samskivert/src/java/com/samskivert/text/MessageUtil.java @@ -3,6 +3,8 @@ package com.samskivert.text; +import java.text.MessageFormat; + import com.samskivert.util.StringUtil; /** @@ -24,8 +26,7 @@ public class MessageUtil /** * Call this to "taint" any string that has been entered by an entity * outside the application so that the translation code knows not to - * attempt to translate this string when doing recursive translations - * (see {@link #xlate}). + * attempt to translate this string when doing recursive translations. */ public static String taint (Object text) { @@ -34,7 +35,8 @@ public class MessageUtil /** * Composes a message key with an array of arguments. The message can - * subsequently be translated in a single call using {@link #xlate}. + * subsequently be decomposed and translated without prior knowledge + * of how many arguments were provided. */ public static String compose (String key, Object[] args) { diff --git a/projects/samskivert/src/java/com/samskivert/util/CalendarUtil.java b/projects/samskivert/src/java/com/samskivert/util/CalendarUtil.java index 0212181f..4da86768 100644 --- a/projects/samskivert/src/java/com/samskivert/util/CalendarUtil.java +++ b/projects/samskivert/src/java/com/samskivert/util/CalendarUtil.java @@ -28,10 +28,10 @@ public class CalendarUtil * leap seconds, etc. The order of the two dates in time does not * matter, the absolute number of days between them will be returned. * + *

From: http://www.jguru.com/forums/view.jsp?EID=489372 + * * @return the number of days between d1 and d2, 0 if they are the * same day. - * - * @author http://www.jguru.com/forums/view.jsp?EID=489372 */ public static int getDaysBetween (Calendar d1, Calendar d2) { diff --git a/projects/samskivert/src/java/com/samskivert/util/ClassUtil.java b/projects/samskivert/src/java/com/samskivert/util/ClassUtil.java index c8df9476..17349491 100644 --- a/projects/samskivert/src/java/com/samskivert/util/ClassUtil.java +++ b/projects/samskivert/src/java/com/samskivert/util/ClassUtil.java @@ -165,8 +165,8 @@ public class ClassUtil * * @param clazz a class. * @param methodName name of a method. - * @param paramTypes Class array representing the types of a method's - * formal parameters. + * @param parameterTypes Class array representing the types of a + * method's formal parameters. * * @return the nearest method located, or null if there is no such * method. diff --git a/projects/samskivert/src/java/com/samskivert/util/SortableArrayList.java b/projects/samskivert/src/java/com/samskivert/util/SortableArrayList.java index d5636a25..baaf66cd 100644 --- a/projects/samskivert/src/java/com/samskivert/util/SortableArrayList.java +++ b/projects/samskivert/src/java/com/samskivert/util/SortableArrayList.java @@ -24,6 +24,7 @@ import java.io.Serializable; import java.util.AbstractList; import java.util.ArrayList; +import java.util.Arrays; import java.util.Comparator; import java.util.List; import java.util.RandomAccess;