hbase-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From st...@apache.org
Subject svn commit: r901840 [1/2] - in /hadoop/hbase/trunk: CHANGES.txt build.xml src/java/org/apache/hadoop/hbase/thrift/Hbase.thrift src/java/org/apache/hadoop/hbase/thrift/generated/Hbase.java
Date Thu, 21 Jan 2010 19:53:01 GMT
Author: stack
Date: Thu Jan 21 19:53:00 2010
New Revision: 901840

URL: http://svn.apache.org/viewvc?rev=901840&view=rev
Log:
HBASE-2151 Remove onelab and include generated thrift classes in javadoc

Modified:
    hadoop/hbase/trunk/CHANGES.txt
    hadoop/hbase/trunk/build.xml
    hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/thrift/Hbase.thrift
    hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/thrift/generated/Hbase.java

Modified: hadoop/hbase/trunk/CHANGES.txt
URL: http://svn.apache.org/viewvc/hadoop/hbase/trunk/CHANGES.txt?rev=901840&r1=901839&r2=901840&view=diff
==============================================================================
--- hadoop/hbase/trunk/CHANGES.txt (original)
+++ hadoop/hbase/trunk/CHANGES.txt Thu Jan 21 19:53:00 2010
@@ -323,6 +323,8 @@
    HBASE-2133  Increase default number of client handlers
    HBASE-2109  status 'simple' should show total requests per second, also 
    	       the requests/sec is wrong as is
+   HBASE-2151  Remove onelab and include generated thrift classes in javadoc
+               (Lars Francke via Stack)
 
   NEW FEATURES
    HBASE-1961  HBase EC2 scripts

Modified: hadoop/hbase/trunk/build.xml
URL: http://svn.apache.org/viewvc/hadoop/hbase/trunk/build.xml?rev=901840&r1=901839&r2=901840&view=diff
==============================================================================
--- hadoop/hbase/trunk/build.xml (original)
+++ hadoop/hbase/trunk/build.xml Thu Jan 21 19:53:00 2010
@@ -428,8 +428,6 @@
       >
       <packageset dir="${src.dir}">
           <include name="org/apache/**"/>
-          <exclude name="org/onelab/**"/>
-          <exclude name="org/apache/hadoop/hbase/thrift/generated/**"/>
       </packageset>
         <link href="${javadoc.link.java}"/>
         <classpath >

Modified: hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/thrift/Hbase.thrift
URL: http://svn.apache.org/viewvc/hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/thrift/Hbase.thrift?rev=901840&r1=901839&r2=901840&view=diff
==============================================================================
--- hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/thrift/Hbase.thrift (original)
+++ hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/thrift/Hbase.thrift Thu Jan 21 19:53:00
2010
@@ -17,15 +17,14 @@
  */
 
 // ----------------------------------------------------------------
-// HBase.thrift -
+// Hbase.thrift
 //
 // This is a Thrift interface definition file for the Hbase service.
 // Target language libraries for C++, Java, Ruby, PHP, (and more) are
 // generated by running this file through the Thrift compiler with the
-// appropriate flags.  The Thrift compiler binary and runtime
-// libraries for various languages is currently available from
-// Facebook (http://developers.facebook.com/thrift/).  The intent is
-// for the Thrift project to migrate to Apache Incubator.
+// appropriate flags. The Thrift compiler binary and runtime
+// libraries for various languages are available
+// from the Apache Incubator (http://incubator.apache.org/thrift/)
 //
 // See the package.html file for information on the version of Thrift
 // used to generate the *.java files checked into the Hbase project.
@@ -37,8 +36,6 @@
 namespace py hbase
 namespace perl Hbase
 
-// note: other language namespaces tbd...
-
 //
 // Types
 //
@@ -154,25 +151,28 @@
 service Hbase {
   /**
    * Brings a table on-line (enables it)
-   * @param tableName name of the table
    */
-  void enableTable(1:Bytes tableName)
-    throws (1:IOError io)
+  void enableTable(
+    /** name of the table */
+    1:Bytes tableName
+  ) throws (1:IOError io)
     
   /**
    * Disables a table (takes it off-line) If it is being served, the master
    * will tell the servers to stop serving it.
-   * @param tableName name of the table
    */
-  void disableTable(1:Bytes tableName)
-    throws (1:IOError io)
+  void disableTable(
+    /** name of the table */
+    1:Bytes tableName
+  ) throws (1:IOError io)
 
   /**
-   * @param tableName name of table to check
    * @return true if table is on-line
    */
-  bool isTableEnabled(1:Bytes tableName)
-    throws (1:IOError io)
+  bool isTableEnabled(
+    /** name of the table to check */
+    1:Bytes tableName
+  ) throws (1:IOError io)
     
   void compact(1:Bytes tableNameOrRegionName)
     throws (1:IOError io)
@@ -182,320 +182,426 @@
     
   /**
    * List all the userspace tables.
-   * @return - returns a list of names
+   * @return returns a list of names
    */
   list<Text> getTableNames()
     throws (1:IOError io)
 
   /**
    * List all the column families assoicated with a table.
-   * @param tableName table name
    * @return list of column family descriptors
    */
-  map<Text,ColumnDescriptor> getColumnDescriptors (1:Text tableName)
-    throws (1:IOError io)
+  map<Text,ColumnDescriptor> getColumnDescriptors (
+    /** table name */
+    1:Text tableName
+  ) throws (1:IOError io)
 
   /**
    * List the regions associated with a table.
-   * @param tableName table name
    * @return list of region descriptors
    */
-  list<TRegionInfo> getTableRegions(1:Text tableName) 
+  list<TRegionInfo> getTableRegions(
+    /** table name */
+    1:Text tableName)
     throws (1:IOError io)
 
   /**
    * Create a table with the specified column families.  The name
    * field for each ColumnDescriptor must be set and must end in a
-   * colon (:).  All other fields are optional and will get default
+   * colon (:). All other fields are optional and will get default
    * values if not explicitly specified.
    *
-   * @param tableName name of table to create
-   * @param columnFamilies list of column family descriptors
-   *
    * @throws IllegalArgument if an input parameter is invalid
    * @throws AlreadyExists if the table name already exists
-   */ 
-  void createTable(1:Text tableName, 2:list<ColumnDescriptor> columnFamilies)
-    throws (1:IOError io, 2:IllegalArgument ia, 3:AlreadyExists exist)
+   */
+  void createTable(
+    /** name of table to create */
+    1:Text tableName,
+
+    /** list of column family descriptors */
+    2:list<ColumnDescriptor> columnFamilies
+  ) throws (1:IOError io, 2:IllegalArgument ia, 3:AlreadyExists exist)
 
   /**
    * Deletes a table
-   * @param tableName name of table to delete
+   *
    * @throws IOError if table doesn't exist on server or there was some other
    * problem
    */
-  void deleteTable(1:Text tableName)
-    throws (1:IOError io)
+  void deleteTable(
+    /** name of table to delete */
+    1:Text tableName
+  ) throws (1:IOError io)
 
   /** 
    * Get a single TCell for the specified table, row, and column at the
    * latest timestamp. Returns an empty list if no such value exists.
    *
-   * @param tableName name of table
-   * @param row row key
-   * @param column column name
    * @return value for specified row/column
    */
-  list<TCell> get(1:Text tableName, 2:Text row, 3:Text column) 
-    throws (1:IOError io)
+  list<TCell> get(
+    /** name of table */
+    1:Text tableName,
+
+    /** row key */
+    2:Text row,
+
+    /** column name */
+    3:Text column
+  ) throws (1:IOError io)
 
   /** 
    * Get the specified number of versions for the specified table,
    * row, and column.
    *
-   * @param tableName name of table
-   * @param row row key
-   * @param column column name
-   * @param numVersions number of versions to retrieve
    * @return list of cells for specified row/column
    */
-  list<TCell> getVer(1:Text tableName, 2:Text row, 3:Text column,
-      4:i32 numVersions) 
-    throws (1:IOError io)
+  list<TCell> getVer(
+    /** name of table */
+    1:Text tableName,
+
+    /** row key */
+    2:Text row,
+
+    /** column name */
+    3:Text column,
+
+    /** number of versions to retrieve */
+    4:i32 numVersions
+  ) throws (1:IOError io)
 
   /** 
    * Get the specified number of versions for the specified table,
    * row, and column.  Only versions less than or equal to the specified
    * timestamp will be returned.
    *
-   * @param tableName name of table
-   * @param row row key
-   * @param column column name
-   * @param timestamp timestamp
-   * @param numVersions number of versions to retrieve
    * @return list of cells for specified row/column
    */
-  list<TCell> getVerTs(1:Text tableName, 2:Text row, 3:Text column, 
-      4:i64 timestamp,  5:i32 numVersions)
-    throws (1:IOError io)
+  list<TCell> getVerTs(
+    /** name of table */
+    1:Text tableName,
+
+    /** row key */
+    2:Text row,
+
+    /** column name */
+    3:Text column,
+
+    /** timestamp */
+    4:i64 timestamp,
+
+    /** number of versions to retrieve */
+    5:i32 numVersions
+  ) throws (1:IOError io)
 
   /** 
    * Get all the data for the specified table and row at the latest
    * timestamp. Returns an empty list if the row does not exist.
    * 
-   * @param tableName name of table
-   * @param row row key
    * @return TRowResult containing the row and map of columns to TCells
    */
-  list<TRowResult> getRow(1:Text tableName, 2:Text row)
-    throws (1:IOError io)
+  list<TRowResult> getRow(
+    /** name of table */
+    1:Text tableName,
+
+    /** row key */
+    2:Text row
+  ) throws (1:IOError io)
 
   /** 
    * Get the specified columns for the specified table and row at the latest
    * timestamp. Returns an empty list if the row does not exist.
    * 
-   * @param tableName name of table
-   * @param row row key
-   * @param columns List of columns to return, null for all columns
    * @return TRowResult containing the row and map of columns to TCells
    */
-  list<TRowResult> getRowWithColumns(1:Text tableName, 2:Text row,
-      3:list<Text> columns)
-    throws (1:IOError io)
+  list<TRowResult> getRowWithColumns(
+    /** name of table */
+    1:Text tableName,
+
+    /** row key */
+    2:Text row,
+
+    /** List of columns to return, null for all columns */
+    3:list<Text> columns
+  ) throws (1:IOError io)
 
   /** 
    * Get all the data for the specified table and row at the specified
    * timestamp. Returns an empty list if the row does not exist.
    * 
-   * @param tableName of table
-   * @param row row key
-   * @param timestamp timestamp
    * @return TRowResult containing the row and map of columns to TCells
    */
-  list<TRowResult> getRowTs(1:Text tableName, 2:Text row, 3:i64 timestamp)
-    throws (1:IOError io)
+  list<TRowResult> getRowTs(
+    /** name of the table */
+    1:Text tableName,
+
+    /** row key */
+    2:Text row,
+
+    /** timestamp */
+    3:i64 timestamp
+  ) throws (1:IOError io)
     
   /** 
    * Get the specified columns for the specified table and row at the specified
    * timestamp. Returns an empty list if the row does not exist.
    * 
-   * @param tableName name of table
-   * @param row row key
-   * @param columns List of columns to return, null for all columns
    * @return TRowResult containing the row and map of columns to TCells
    */
-  list<TRowResult> getRowWithColumnsTs(1:Text tableName, 2:Text row,
-      3:list<Text> columns, 4:i64 timestamp)
-    throws (1:IOError io)
+  list<TRowResult> getRowWithColumnsTs(
+    /** name of table */
+    1:Text tableName,
+
+    /** row key */
+    2:Text row,
+
+    /** List of columns to return, null for all columns */
+    3:list<Text> columns,
+    4:i64 timestamp
+  ) throws (1:IOError io)
 
   /** 
    * Apply a series of mutations (updates/deletes) to a row in a
    * single transaction.  If an exception is thrown, then the
    * transaction is aborted.  Default current timestamp is used, and
    * all entries will have an identical timestamp.
-   *
-   * @param tableName name of table
-   * @param row row key
-   * @param mutations list of mutation commands
    */
-  void mutateRow(1:Text tableName, 2:Text row, 3:list<Mutation> mutations)
-    throws (1:IOError io, 2:IllegalArgument ia)
+  void mutateRow(
+    /** name of table */
+    1:Text tableName,
+
+    /** row key */
+    2:Text row,
+
+    /** list of mutation commands */
+    3:list<Mutation> mutations
+  ) throws (1:IOError io, 2:IllegalArgument ia)
 
   /** 
    * Apply a series of mutations (updates/deletes) to a row in a
    * single transaction.  If an exception is thrown, then the
    * transaction is aborted.  The specified timestamp is used, and
    * all entries will have an identical timestamp.
-   *
-   * @param tableName name of table
-   * @param row row key
-   * @param mutations list of mutation commands
-   * @param timestamp timestamp
    */
-  void mutateRowTs(1:Text tableName, 2:Text row, 3:list<Mutation> mutations, 4:i64
timestamp)
-    throws (1:IOError io, 2:IllegalArgument ia)
+  void mutateRowTs(
+    /** name of table */
+    1:Text tableName,
+
+    /** row key */
+    2:Text row,
+
+    /** list of mutation commands */
+    3:list<Mutation> mutations,
+
+    /** timestamp */
+    4:i64 timestamp
+  ) throws (1:IOError io, 2:IllegalArgument ia)
 
   /** 
    * Apply a series of batches (each a series of mutations on a single row)
    * in a single transaction.  If an exception is thrown, then the
    * transaction is aborted.  Default current timestamp is used, and
    * all entries will have an identical timestamp.
-   *
-   * @param tableName name of table
-   * @param rowBatches list of row batches
    */
-  void mutateRows(1:Text tableName, 2:list<BatchMutation> rowBatches)
-    throws (1:IOError io, 2:IllegalArgument ia)
+  void mutateRows(
+    /** name of table */
+    1:Text tableName,
+
+    /** list of row batches */
+    2:list<BatchMutation> rowBatches
+  ) throws (1:IOError io, 2:IllegalArgument ia)
 
   /** 
    * Apply a series of batches (each a series of mutations on a single row)
    * in a single transaction.  If an exception is thrown, then the
    * transaction is aborted.  The specified timestamp is used, and
    * all entries will have an identical timestamp.
-   *
-   * @param tableName name of table
-   * @param rowBatches list of row batches
-   * @param timestamp timestamp
    */
-  void mutateRowsTs(1:Text tableName, 2:list<BatchMutation> rowBatches, 3:i64 timestamp)
-    throws (1:IOError io, 2:IllegalArgument ia)
+  void mutateRowsTs(
+    /** name of table */
+    1:Text tableName,
+
+    /** list of row batches */
+    2:list<BatchMutation> rowBatches,
+
+    /** timestamp */
+    3:i64 timestamp
+  ) throws (1:IOError io, 2:IllegalArgument ia)
 
   /**
    * Atomically increment the column value specified.  Returns the next value post increment.
-   * @param tableName name of table
-   * @param row row to increment
-   * @param column name of column
-   * @param value amount to increment by
    */
-  i64 atomicIncrement(1:Text tableName, 2:Text row, 3:Text column, 4:i64 value)
-    throws (1:IOError io, 2:IllegalArgument ia)
+  i64 atomicIncrement(
+    /** name of table */
+    1:Text tableName,
+
+    /** row to increment */
+    2:Text row,
+
+    /** name of column */
+    3:Text column,
+
+    /** amount to increment by */
+    4:i64 value
+  ) throws (1:IOError io, 2:IllegalArgument ia)
     
   /** 
    * Delete all cells that match the passed row and column.
-   *
-   * @param tableName name of table
-   * @param row Row to update
-   * @param column name of column whose value is to be deleted
    */
-  void deleteAll(1:Text tableName, 2:Text row, 3:Text column)
-    throws (1:IOError io)
+  void deleteAll(
+    /** name of table */
+    1:Text tableName,
+
+    /** Row to update */
+    2:Text row,
+
+    /** name of column whose value is to be deleted */
+    3:Text column
+  ) throws (1:IOError io)
 
   /** 
    * Delete all cells that match the passed row and column and whose
    * timestamp is equal-to or older than the passed timestamp.
-   *
-   * @param tableName name of table
-   * @param row Row to update
-   * @param column name of column whose value is to be deleted
-   * @param timestamp timestamp
    */
-  void deleteAllTs(1:Text tableName, 2:Text row, 3:Text column, 4:i64 timestamp)
-    throws (1:IOError io)
+  void deleteAllTs(
+    /** name of table */
+    1:Text tableName,
+
+    /** Row to update */
+    2:Text row,
+
+    /** name of column whose value is to be deleted */
+    3:Text column,
+
+    /** timestamp */
+    4:i64 timestamp
+  ) throws (1:IOError io)
 
   /**
    * Completely delete the row's cells.
-   *
-   * @param tableName name of table
-   * @param row key of the row to be completely deleted.
    */
-  void deleteAllRow(1:Text tableName, 2:Text row)
-    throws (1:IOError io)
+  void deleteAllRow(
+    /** name of table */
+    1:Text tableName,
+
+    /** key of the row to be completely deleted. */
+    2:Text row
+  ) throws (1:IOError io)
 
   /**
    * Completely delete the row's cells marked with a timestamp
    * equal-to or older than the passed timestamp.
-   *
-   * @param tableName name of table
-   * @param row key of the row to be completely deleted.
-   * @param timestamp timestamp
    */
-  void deleteAllRowTs(1:Text tableName, 2:Text row, 3:i64 timestamp)
-    throws (1:IOError io)
+  void deleteAllRowTs(
+    /** name of table */
+    1:Text tableName,
+
+    /** key of the row to be completely deleted. */
+    2:Text row,
+
+    /** timestamp */
+    3:i64 timestamp
+  ) throws (1:IOError io)
 
   /** 
    * Get a scanner on the current table starting at the specified row and
    * ending at the last row in the table.  Return the specified columns.
    *
-   * @param columns columns to scan. If column name is a column family, all
-   * columns of the specified column family are returned.  Its also possible
-   * to pass a regex in the column qualifier.
-   * @param tableName name of table
-   * @param startRow starting row in table to scan.  send "" (empty string) to
-   *                 start at the first row.
-   *
    * @return scanner id to be used with other scanner procedures
    */
-  ScannerID scannerOpen(1:Text tableName, 
-                        2:Text startRow,
-                        3:list<Text> columns)
-    throws (1:IOError io)
+  ScannerID scannerOpen(
+    /** name of table */
+    1:Text tableName,
+
+    /**
+     * Starting row in table to scan.
+     * Send "" (empty string) to start at the first row.
+     */
+    2:Text startRow,
+
+    /**
+     * columns to scan. If column name is a column family, all
+     * columns of the specified column family are returned. It's also possible
+     * to pass a regex in the column qualifier.
+     */
+    3:list<Text> columns
+  ) throws (1:IOError io)
 
   /** 
    * Get a scanner on the current table starting and stopping at the
    * specified rows.  ending at the last row in the table.  Return the
    * specified columns.
    *
-   * @param columns columns to scan. If column name is a column family, all
-   * columns of the specified column family are returned.  Its also possible
-   * to pass a regex in the column qualifier.
-   * @param tableName name of table
-   * @param startRow starting row in table to scan.  send "" (empty string) to
-   *                 start at the first row.
-   * @param stopRow row to stop scanning on.  This row is *not* included in the
-   *                scanner's results
-   *
    * @return scanner id to be used with other scanner procedures
    */
-  ScannerID scannerOpenWithStop(1:Text tableName, 
-                                2:Text startRow,
-                                3:Text stopRow, 
-                                4:list<Text> columns)
-    throws (1:IOError io)
+  ScannerID scannerOpenWithStop(
+    /** name of table */
+    1:Text tableName,
+
+    /**
+     * Starting row in table to scan.
+     * Send "" (empty string) to start at the first row.
+     */
+    2:Text startRow,
+
+    /**
+     * row to stop scanning on. This row is *not* included in the
+     * scanner's results
+     */
+    3:Text stopRow,
+
+    /**
+     * columns to scan. If column name is a column family, all
+     * columns of the specified column family are returned. It's also possible
+     * to pass a regex in the column qualifier.
+     */
+    4:list<Text> columns
+  ) throws (1:IOError io)
 
   /**
    * Open a scanner for a given prefix.  That is all rows will have the specified
    * prefix. No other rows will be returned.
    *
-   * @param tableName name of table
-   * @param startAndPrefix the prefix (and thus start row) of the keys you want
-   * @param columns the columns you want returned
    * @return scanner id to use with other scanner calls
    */
-  ScannerID scannerOpenWithPrefix(1:Text tableName,
-                                  2:Text startAndPrefix,
-                                  3:list<Text> columns)
-    throws (1:IOError io)
+  ScannerID scannerOpenWithPrefix(
+    /** name of table */
+    1:Text tableName,
+
+    /** the prefix (and thus start row) of the keys you want */
+    2:Text startAndPrefix,
+
+    /** the columns you want returned */
+    3:list<Text> columns
+  ) throws (1:IOError io)
 
   /** 
    * Get a scanner on the current table starting at the specified row and
    * ending at the last row in the table.  Return the specified columns.
    * Only values with the specified timestamp are returned.
    *
-   * @param columns columns to scan. If column name is a column family, all
-   * columns of the specified column family are returned.  Its also possible
-   * to pass a regex in the column qualifier.
-   * @param tableName name of table
-   * @param startRow starting row in table to scan.  send "" (empty string) to
-   *                 start at the first row.
-   * @param timestamp timestamp
-   *
    * @return scanner id to be used with other scanner procedures
    */
-  ScannerID scannerOpenTs(1:Text tableName, 
-                          2:Text startRow,
-                          3:list<Text> columns,
-                          4:i64 timestamp)
-    throws (1:IOError io)
+  ScannerID scannerOpenTs(
+    /** name of table */
+    1:Text tableName,
+
+    /**
+     * Starting row in table to scan.
+     * Send "" (empty string) to start at the first row.
+     */
+    2:Text startRow,
+
+    /**
+     * columns to scan. If column name is a column family, all
+     * columns of the specified column family are returned. It's also possible
+     * to pass a regex in the column qualifier.
+     */
+    3:list<Text> columns,
+
+    /** timestamp */
+    4:i64 timestamp
+  ) throws (1:IOError io)
 
   /** 
    * Get a scanner on the current table starting and stopping at the
@@ -503,24 +609,34 @@
    * specified columns.  Only values with the specified timestamp are
    * returned.
    *
-   * @param columns columns to scan. If column name is a column family, all
-   * columns of the specified column family are returned.  Its also possible
-   * to pass a regex in the column qualifier.
-   * @param tableName name of table
-   * @param startRow starting row in table to scan.  send "" (empty string) to
-   *                 start at the first row.
-   * @param stopRow row to stop scanning on.  This row is *not* included
-   *                in the scanner's results
-   * @param timestamp timestamp
-   *
    * @return scanner id to be used with other scanner procedures
    */
-  ScannerID scannerOpenWithStopTs(1:Text tableName, 
-                                  2:Text startRow,
-                                  3:Text stopRow, 
-                                  4:list<Text> columns,
-                                  5:i64 timestamp)
-    throws (1:IOError io)
+  ScannerID scannerOpenWithStopTs(
+    /** name of table */
+    1:Text tableName,
+
+    /**
+     * Starting row in table to scan.
+     * Send "" (empty string) to start at the first row.
+     */
+    2:Text startRow,
+
+    /**
+     * row to stop scanning on. This row is *not* included in the
+     * scanner's results
+     */
+    3:Text stopRow,
+
+    /**
+     * columns to scan. If column name is a column family, all
+     * columns of the specified column family are returned. It's also possible
+     * to pass a regex in the column qualifier.
+     */
+    4:list<Text> columns,
+
+    /** timestamp */
+    5:i64 timestamp
+  ) throws (1:IOError io)
 
   /**
    * Returns the scanner's current row value and advances to the next
@@ -528,13 +644,14 @@
    * greater-than-or-equal-to the scanner's specified stopRow is reached,
    * an empty list is returned.
    *
-   * @param id id of a scanner returned by scannerOpen
    * @return a TRowResult containing the current row and a map of the columns to TCells.
    * @throws IllegalArgument if ScannerID is invalid
    * @throws NotFound when the scanner reaches the end
    */
-  list<TRowResult> scannerGet(1:ScannerID id)
-    throws (1:IOError io, 2:IllegalArgument ia)
+  list<TRowResult> scannerGet(
+    /** id of a scanner returned by scannerOpen */
+    1:ScannerID id
+  ) throws (1:IOError io, 2:IllegalArgument ia)
 
   /**
    * Returns, starting at the scanner's current row value nbRows worth of
@@ -542,21 +659,25 @@
    * rows in the table, or a key greater-than-or-equal-to the scanner's 
    * specified stopRow is reached,  an empty list is returned.
    *
-   * @param id id of a scanner returned by scannerOpen
-   * @param nbRows number of results to regturn
    * @return a TRowResult containing the current row and a map of the columns to TCells.
    * @throws IllegalArgument if ScannerID is invalid
    * @throws NotFound when the scanner reaches the end
    */
-  list<TRowResult> scannerGetList(1:ScannerID id,2:i32 nbRows)
-    throws (1:IOError io, 2:IllegalArgument ia)
+  list<TRowResult> scannerGetList(
+    /** id of a scanner returned by scannerOpen */
+    1:ScannerID id,
+
+    /** number of results to return */
+    2:i32 nbRows
+  ) throws (1:IOError io, 2:IllegalArgument ia)
 
   /**
    * Closes the server-state associated with an open scanner.
    *
-   * @param id id of a scanner returned by scannerOpen
    * @throws IllegalArgument if ScannerID is invalid
    */
-  void scannerClose(1:ScannerID id)
-    throws (1:IOError io, 2:IllegalArgument ia)
+  void scannerClose(
+    /** id of a scanner returned by scannerOpen */
+    1:ScannerID id
+  ) throws (1:IOError io, 2:IllegalArgument ia)
 }



Mime
View raw message