Changeset 2282 for branches

Timestamp:

08/29/11 12:13:04 (13 years ago)

Author:

KohjiNakamura

Message:

Comments in TableTraverse?.h were updated

File:

• branches/parallel/src/TableTraverse.h (modified) (2 diffs)

branches/parallel/src/TableTraverse.h

@@ -52 +52 @@
 
   // This template is applicable to the type which can be applied to
-  // casa::ObjCompare<T>.
+  // <src>casa::ObjCompare&lt;T&gt;</src>.
   template<class T> class TypeManagerImpl: public TypeManager {
   public:
@@ -71 +71 @@
 
 
-  // <p>This function iterates over 'table' and calls 'visitor->visit()'
-  // for each record and, finally, calls 'visitor->finish()'.</p>
-  // <p>'columnNames' should be a NULL terminated array of column names which
-  // will be used to sort records to determine the order of visits.
-  // if 'doSort' is False, 'columnNames' is used only to specify
-  // 'nCols' and 'colValues' arguments for calling 'visitor->visit()'.</p>
-  // <p>'typeManagers' should be a NULL terminated array of TypeManager.
+  // <p>This function iterates over <src>table</src> with calling
+  // <src>visitor->visit()</src> for each record after calling
+  // <src>visitor->start()</src> and, finally, it calls
+  // <src>visitor->finish()</src>.</p>
+  // <p><src>columnNames</src> should be a NULL terminated array of column
+  // names which will be used to sort records to determine the order of visits.
+  // If <src>doSort</src> is False, <src>columnNames</src> is used only to
+  // specify <src>nCols</src> and <src>colValues</src> arguments for calling
+  // <src>visitor->visit()</src>.</p>
+  // <p><src>typeManagers</src> should be a NULL terminated array of
+  // <src>TypeManager</src> too.
   // It's number of elements and order of elements should be same as
-  // 'columnNames'.
-  // TypeManagerImpl is useful to create instances of TypeManager.</p>
-  // <p>If 'doSort' is True, the order of visits is ascending order for each
-  // column. 'columnNames[0]' is a primary sort key and columnNames[1]
-  // is a secondary sort key, ...</p>
+  // <src>columnNames</src>.
+  // <src>TypeManagerImpl</src> is useful to create instances of
+  // <src>TypeManager</src>.</p>
+  // <p>If <src>doSort</src> is True, the order of visits is ascending order
+  // for each column. <src>columnNames[0]</src> is a primary sort key and
+  // <src>columnNames[1]</src> is a secondary sort key, ...</p>
   void traverseTable(const casa::Table &table,
                      const char *const columnNames[],