Changeset 2282 for branches/parallel/src


Ignore:
Timestamp:
08/29/11 12:13:04 (13 years ago)
Author:
KohjiNakamura
Message:

Comments in TableTraverse.h were updated

File:
1 edited

Legend:

Unmodified
Added
Removed
  • branches/parallel/src/TableTraverse.h

    r2281 r2282  
    5252
    5353  // This template is applicable to the type which can be applied to
    54   // casa::ObjCompare<T>.
     54  // <src>casa::ObjCompare&lt;T&gt;</src>.
    5555  template<class T> class TypeManagerImpl: public TypeManager {
    5656  public:
     
    7171
    7272
    73   // <p>This function iterates over 'table' and calls 'visitor->visit()'
    74   // for each record and, finally, calls 'visitor->finish()'.</p>
    75   // <p>'columnNames' should be a NULL terminated array of column names which
    76   // will be used to sort records to determine the order of visits.
    77   // if 'doSort' is False, 'columnNames' is used only to specify
    78   // 'nCols' and 'colValues' arguments for calling 'visitor->visit()'.</p>
    79   // <p>'typeManagers' should be a NULL terminated array of TypeManager.
     73  // <p>This function iterates over <src>table</src> with calling
     74  // <src>visitor->visit()</src> for each record after calling
     75  // <src>visitor->start()</src> and, finally, it calls
     76  // <src>visitor->finish()</src>.</p>
     77  // <p><src>columnNames</src> should be a NULL terminated array of column
     78  // names which will be used to sort records to determine the order of visits.
     79  // If <src>doSort</src> is False, <src>columnNames</src> is used only to
     80  // specify <src>nCols</src> and <src>colValues</src> arguments for calling
     81  // <src>visitor->visit()</src>.</p>
     82  // <p><src>typeManagers</src> should be a NULL terminated array of
     83  // <src>TypeManager</src> too.
    8084  // It's number of elements and order of elements should be same as
    81   // 'columnNames'.
    82   // TypeManagerImpl is useful to create instances of TypeManager.</p>
    83   // <p>If 'doSort' is True, the order of visits is ascending order for each
    84   // column. 'columnNames[0]' is a primary sort key and columnNames[1]
    85   // is a secondary sort key, ...</p>
     85  // <src>columnNames</src>.
     86  // <src>TypeManagerImpl</src> is useful to create instances of
     87  // <src>TypeManager</src>.</p>
     88  // <p>If <src>doSort</src> is True, the order of visits is ascending order
     89  // for each column. <src>columnNames[0]</src> is a primary sort key and
     90  // <src>columnNames[1]</src> is a secondary sort key, ...</p>
    8691  void traverseTable(const casa::Table &table,
    8792                     const char *const columnNames[],
Note: See TracChangeset for help on using the changeset viewer.