提交 232ba70f authored 作者: noelgrandin@gmail.com's avatar noelgrandin@gmail.com

fix javadoc @param comments

上级 93c4c62d
......@@ -184,8 +184,6 @@ public abstract class Prepared {
/**
* Prepare this statement.
*
* @throws SQLException
*/
public void prepare() {
// nothing to do
......
......@@ -263,7 +263,7 @@ public abstract class Query extends Prepared {
/**
* Execute the query, writing the result to the target result.
*
* @param maxrows the maximum number of rows to return
* @param limit the maximum number of rows to return
* @param target the target result (null will return the result)
* @return the result set (if the target is not set).
*/
......
......@@ -125,7 +125,7 @@ public class UndoLog {
/**
* Go to the right position in the file.
*
* @param file the file
* @param filePos the position in the file
*/
void seek(long filePos) {
file.seek(filePos * Constants.FILE_BLOCK_SIZE);
......
......@@ -464,7 +464,7 @@ public class Comparison extends Condition {
*
* @param session the session
* @param other the second condition
* @param add true for AND, false for OR
* @param and true for AND, false for OR
* @return null or the third condition
*/
Expression getAdditional(Session session, Comparison other, boolean and) {
......
......@@ -107,7 +107,7 @@ public abstract class BaseIndex extends SchemaObjectBase implements Index {
* @param higherThan the lower limit (excluding)
* @param last the last row, or null for no limit
* @return the cursor
* @throws DbException
* @throws DbException always
*/
public Cursor findNext(Session session, SearchRow higherThan, SearchRow last) {
throw DbException.throwInternalError();
......
......@@ -151,7 +151,7 @@ public abstract class PageBtree extends Page {
*
* @param cursor the cursor
* @param first the row to find
* @param if the row should be bigger
* @param bigger if the row should be bigger
*/
abstract void find(PageBtreeCursor cursor, SearchRow first, boolean bigger);
......
......@@ -68,10 +68,9 @@ public class PageDataOverflow extends Page {
/**
* Create an object from the given data page.
*
* @param leaf the leaf page
* @param store the page store
* @param pageId the page id
* @param data the data page
* @param offset the offset
*/
private PageDataOverflow(PageStore store, int pageId, Data data) {
this.store = store;
......
......@@ -267,7 +267,7 @@ public class JdbcCallableStatement extends JdbcPreparedStatement implements Call
/**
* Returns the value of the specified column as a BigDecimal.
*
* @deprecated
* @deprecated use {@link #getBigDecimal(String)} or {@link #getBigDecimal(int)}
*
* @param parameterIndex the parameter index (1, 2, ...)
* @param scale is ignored
......
......@@ -669,7 +669,7 @@ public class JdbcPreparedStatement extends JdbcStatement implements PreparedStat
/**
* [Not supported] This feature is deprecated and not supported.
*
* @deprecated
* @deprecated this feature is deprecated.
*/
public void setUnicodeStream(int parameterIndex, InputStream x, int length) throws SQLException {
throw unsupported("unicodeStream");
......
......@@ -696,7 +696,7 @@ public class JdbcResultSet extends TraceObject implements ResultSet {
/**
* Returns the value of the specified column as a BigDecimal.
*
* @deprecated
* @deprecated use {@link #getBigDecimal(String)} or {@link #getBigDecimal(int)}
*
* @param columnLabel the column label
* @param scale the scale of the returned value
......@@ -722,7 +722,7 @@ public class JdbcResultSet extends TraceObject implements ResultSet {
/**
* Returns the value of the specified column as a BigDecimal.
*
* @deprecated
* @deprecated use {@link #getBigDecimal(String)} or {@link #getBigDecimal(int)}
*
* @param columnIndex (1,2,...)
* @param scale the scale of the returned value
......
......@@ -122,7 +122,7 @@ public class WebApp {
* Process an HTTP request.
*
* @param file the file that was requested
* @param the host address
* @param hostAddr the host address
* @return the name of the file to return to the client
*/
String processRequest(String file, String hostAddr) {
......
......@@ -145,7 +145,6 @@ public class DataReader extends Reader {
/**
* Read one character from the input stream.
*
* @param in the input stream
* @return the character
*/
private char readChar() throws IOException {
......
......@@ -416,7 +416,7 @@ public class PageLog {
* opening the database.
*
* @param sessionId the session id
* @param the data page with the prepare entry
* @param pageId the data page with the prepare entry
* @param transaction the transaction name, or null to rollback
*/
private void setPrepareCommit(int sessionId, int pageId, String transaction) {
......@@ -533,7 +533,7 @@ public class PageLog {
/**
* Mark a transaction as committed.
*
* @param session the session
* @param sessionId the session
*/
void commit(int sessionId) {
if (trace.isDebugEnabled()) {
......
......@@ -90,7 +90,7 @@ public class PageStreamData extends Page {
* Write the data to the buffer.
*
* @param buff the source data
* @param off the offset in the source buffer
* @param offset the offset in the source buffer
* @param len the number of bytes to write
* @return the number of bytes written
*/
......
......@@ -204,7 +204,7 @@ public class Csv implements SimpleRowSource {
* @param reader the reader
* @param colNames or null if the column names should be read from the CSV file
* @return the result set
* @throws SQLException, IOException
* @throws IOException
*/
public ResultSet read(Reader reader, String[] colNames) throws IOException {
init(null, null);
......
......@@ -168,7 +168,7 @@ public class Transfer {
/**
* Write a double.
*
* @param x the value
* @param i the value
* @return itself
*/
private Transfer writeDouble(double i) throws IOException {
......@@ -179,7 +179,7 @@ public class Transfer {
/**
* Write a float.
*
* @param x the value
* @param i the value
* @return itself
*/
private Transfer writeFloat(float i) throws IOException {
......
......@@ -117,7 +117,6 @@ public class BuildBase {
/**
* Filter a list of file names.
*
* @param files the original list
* @param keep if matching file names should be kept or removed
* @param pattern the file name pattern
* @return the filtered file list
......
......@@ -112,7 +112,7 @@ public class ModelUtils {
/**
* Returns a SQL type mapping for a Java class.
*
* @param field the field to map
* @param fieldDef the field to map
* @param strictTypeMapping throws a RuntimeException if type is unsupported
* @return
*/
......
Markdown 格式
0%
您添加了 0 到此讨论。请谨慎行事。
请先完成此评论的编辑!
注册 或者 后发表评论