Changeset 1039

Timestamp:

06/04/07 14:34:34 (2 years ago)

Author:

kraftche

Message:

Fix numerous typos and spelling mistakes

Files:

• MOAB/trunk/mhdf/include/mhdf.h (modified) (36 diffs)

MOAB/trunk/mhdf/include/mhdf.h

@@ -4 +4 @@
  * 
  * Copyright 2004 Sandia Corporation.  Under the terms of Contract
- * DE-AC04-94AL85000 with Sandia Coroporation, the U.S. Government
+ * DE-AC04-94AL85000 with Sandia Corporation, the U.S. Government
  * retains certain rights in this software.
  * 
@@ -144 +144 @@
  *                   should be used.  If a constant does not exist for
  *                   the type, a similar naming pattern should be used
- *                   (accepted name for type, first charaster uppercase,
+ *                   (accepted name for type, first character uppercase,
  *                   subsequent characters lowercase.)  The element type
  *                   index passed to \ref mhdf_addElement is then an
  *                   index into this list.  The array may contain
- *                   null entires to allow the caller some control over
+ *                   null entries to allow the caller some control over
  *                   the assigned indices without creating dummy types
  *                   which may confuse readers.
@@ -168 +168 @@
  *
  * \param filename   The path and name of the file to open
- * \param writeable  If non-zero, open read-write.  Otherwise readonly.
+ * \param writable  If non-zero, open read-write.  Otherwise read-only.
  * \param status     Passed back status of API call.
  * \param max_id     Used to pass back the maximum global ID used in the
@@ -178 +178 @@
 mhdf_FileHandle
 mhdf_openFile( const char* filename,
-               int writeable,
+               int writable,
                unsigned long* max_id,
                mhdf_Status* status );
@@ -193 +193 @@
  *
  * \param filename   The path and name of the file to open
- * \param writeable  If non-zero, open read-write.  Otherwise readonly.
+ * \param writable  If non-zero, open read-write.  Otherwise read-only.
  * \param status     Passed back status of API call.
  * \param max_id     Used to pass back the maximum global ID used in the
@@ -200 +200 @@
  *                   may be passed.
  * \param options    The HDF5 access property list to use when opening
- *                   the file.  See the HDF5 documenation for H5Fopen.
+ *                   the file.  See the HDF5 documentation for H5Fopen.
  * \return An opaque handle to the file.
  */
 mhdf_FileHandle
 mhdf_openFileWithOpt( const char* filename,
-                      int writeable,
+                      int writable,
                       unsigned long* max_id,
                       hid_t options,
@@ -213 +213 @@
  * Fails if buffer is not of sufficient size.
  * \param file_handle The file.
- * \param type_index The type index.  Corresponds to indicies into
+ * \param type_index The type index.  Corresponds to indices into
  *                   the element type list passed to \ref mhdf_createFile.
  * \param buffer     The buffer into which to copy the name.
@@ -236 +236 @@
  *
  * Close an hid_t-type handle returned from any of the following
- * functions.  Any hid_t passed-back or returnd must be closed via
- * this function to avoid resouce loss.
+ * functions.  Any hid_t passed-back or returned must be closed via
+ * this function to avoid resource loss.
  *
  * \param file   The file the object pointed to by the passed data
@@ -297 +297 @@
  * \param num_nodes    The number of nodes the table will contain.
  * \param first_node_id_out  Nodes are assigned IDs sequentially in the
- *             order they occur in the table, where the ID of the fisrt
+ *             order they occur in the table, where the ID of the first
  *             node in the table is this passed-back value.
  * \param status     Passed back status of API call.
@@ -315 +315 @@
  * \param num_nodes_out    The number of nodes the table contains.
  * \param first_node_id_out  Nodes are assigned IDs sequentially in the
- *             order they occur in the table, where the ID of the fisrt
+ *             order they occur in the table, where the ID of the first
  *             node in the table is this passed-back value.
  * \param status     Passed back status of API call.
@@ -427 +427 @@
  * \param file_handle  File in which to create the element type.
  * \param elem_handle  The name to use for the element data.  This
- *                     name is used as an identifer to reference the
+ *                     name is used as an identifier to reference the
  *                     data for this element type later.  The selected
  *                     name also appears explicitly in the file and 
@@ -488 +488 @@
 /** \brief Check if an element group contains polygon or polyhedron
  *
- * Check if an element group contains general polyhon or polyhedrons
+ * Check if an element group contains general polygon or polyhedrons
  * rather than typically fixed-connectivity elements.  
  *
@@ -633 +633 @@
  * \param num_poly     The total number number of polygons or polyhedra to
  *                     be written in the table.
- * \param data_list_length The tolal number of values to be written to the
+ * \param data_list_length The total number of values to be written to the
  *                     table (the number of polys plus the sum of the number
  *                     of entities in each poly's connectivity data.)
@@ -673 +673 @@
  * \param num_poly_out The total number number of polygons or polyhedra to
  *                     be written in the table.
- * \param data_list_length_out The tolal number of values to be written to the
+ * \param data_list_length_out The total number of values to be written to the
  *                     table (the number of polys plus the sum of the number
  *                     of entities in each poly's connectivity data.)
@@ -711 +711 @@
  * This function writes the index list.
  *
- * \param poly_handle  The handle returnded from 
+ * \param poly_handle  The handle returned from 
  *                     <code>mhdf_createPolyConnectivity</code> or
  *                     <code>mhdf_openPolyConnectivity</code>.
  * \param offset       The offset in the table at which to write.  The
- *                     offset is in terms of the integer valus in the table,
+ *                     offset is in terms of the integer values in the table,
  *                     not the count of polys.
  * \param count        The size of the integer list to write.
@@ -746 +746 @@
  * This function writes the connectivity/ID list.
  *
- * \param poly_handle  The handle returnded from 
+ * \param poly_handle  The handle returned from 
  *                     <code>mhdf_createPolyConnectivity</code> or
  *                     <code>mhdf_openPolyConnectivity</code>.
  * \param offset       The offset in the table at which to write.  The
- *                     offset is in terms of the integer valus in the table,
+ *                     offset is in terms of the integer values in the table,
  *                     not the count of polys.
  * \param count        The size of the integer list to write.
@@ -780 +780 @@
  * elements.)
  *
- * \param poly_handle  The handle returnded from 
+ * \param poly_handle  The handle returned from 
  *                     <code>mhdf_createPolyConnectivity</code> or
  *                     <code>mhdf_openPolyConnectivity</code>.
  * \param offset       The offset in the table at which to read.  The
- *                     offset is in terms of the integer valus in the table,
+ *                     offset is in terms of the integer values in the table,
  *                     not the count of polys.
  * \param count        The size of the integer list to read.
@@ -813 +813 @@
  * elements.)
  *
- * \param poly_handle  The handle returnded from 
+ * \param poly_handle  The handle returned from 
  *                     <code>mhdf_createPolyConnectivity</code> or
  *                     <code>mhdf_openPolyConnectivity</code>.
  * \param offset       The offset in the table at which to read.  The
- *                     offset is in terms of the integer valus in the table,
+ *                     offset is in terms of the integer values in the table,
  *                     not the count of polys.
  * \param count        The size of the integer list to read.
@@ -1020 +1020 @@
 #define mhdf_SET_OWNER_BIT 0x1  
 /** \brief Set cannot contain duplicates */ 
-#define mhdf_SET_UNIQE_BIT 0x2  
+#define mhdf_SET_UNIQUE_BIT 0x2  
 /** \brief Set order is preserved */
 #define mhdf_SET_ORDER_BIT 0x4  
@@ -1047 +1047 @@
  * bit in the flags specifies the format of the contents list for each set.
  * See a description of the \ref mhdf_SET_RANGE_BIT flag for a description
- * of the two possbile data formats.  The index values in the first two columns
+ * of the two possible data formats.  The index values in the first two columns
  * of the table are the index of the <em>last</em> value for the set in the corresponding
  * contents and children lists.  The first index is always one greater than the last index
  * for the previous set in the table.  The first index of the first set in the table is
- * implicitly zero.  A special value of -1 in the appropraite column should be used to 
+ * implicitly zero.  A special value of -1 in the appropriate column should be used to 
  * indicate that the first set contains no contents or has no children.  For any other set,
  * if the last index for the set is the same as that of the previous set, it has no data
@@ -1062 +1062 @@
  *                    will be assigned sequential global IDs.
  * \param status       Passed back status of API call.
- *\return The handle to the set metadata table.  
+ *\return The handle to the set meta-data table.  
  */
 hid_t
@@ -1100 +1100 @@
  *                    have sequential global IDs.
  * \param status       Passed back status of API call.
- *\return The handle to the set metadata table.  
+ *\return The handle to the set meta-data table.  
  */
 hid_t
@@ -1136 +1136 @@
  * Read flags for each set from the set description table.
  * See \ref mhdf_createSetMeta for a description of this data.
- *\param data_handle The handle returnd from mdhf_createSetMeta or mhdf_openSetMeta
+ *\param data_handle The handle returned from mdhf_createSetMeta or mhdf_openSetMeta
  *\param offset      The offset (set index) at which to begin reading.
  *\param count       The number of values (number of sets) to read.
@@ -1160 +1160 @@
  *       first in the list will have an end index of -1.
  * 
- *\param data_handle The handle returnd from mdhf_createSetMeta or mhdf_openSetMeta
+ *\param data_handle The handle returned from mdhf_createSetMeta or mhdf_openSetMeta
  *\param offset      The offset (set index) at which to begin reading.
  *\param count       The number of values (number of sets) to read.
@@ -1183 +1183 @@
  *       first in the list will have an end index of -1.
  * 
- *\param data_handle The handle returnd from mdhf_createSetMeta or mhdf_openSetMeta
+ *\param data_handle The handle returned from mdhf_createSetMeta or mhdf_openSetMeta
  *\param offset      The offset (set index) at which to begin reading.
  *\param count       The number of values (number of sets) to read.
@@ -1206 +1206 @@
  *       first in the list will have an end index of -1.
  * 
- *\param data_handle The handle returnd from mdhf_createSetMeta or mhdf_openSetMeta
+ *\param data_handle The handle returned from mdhf_createSetMeta or mhdf_openSetMeta
  *\param offset      The offset (set index) at which to begin reading.
  *\param count       The number of values (number of sets) to read.
@@ -1251 +1251 @@
  * The format of this data is a vector of integer values which is the
  * concatenation of the contents list for all the meshsets.  The length
- * and format of the data for each set is stored in the set metatable.
+ * and format of the data for each set is stored in the set meta table.
  * See \ref mhdf_createSetMeta and \ref mhdf_SET_RANGE_BIT for a 
  * description of that data.
@@ -1271 +1271 @@
  * The format of this data is a vector of integer values which is the
  * concatenation of the contents list for all the meshsets.  The length
- * and format of the data for each set is stored in the set metatable.
+ * and format of the data for each set is stored in the set meta table.
  * See \ref mhdf_createSetMeta and \ref mhdf_SET_RANGE_BIT for a 
  * description of that data.
@@ -1290 +1290 @@
  * The format of this data is a vector of integer values which is the
  * concatenation of the contents list for all the meshsets.  The length
- * and format of the data for each set is stored in the set metatable.
+ * and format of the data for each set is stored in the set meta table.
  * See \ref mhdf_createSetMeta and \ref mhdf_SET_RANGE_BIT for a 
  * description of that data.
@@ -1318 +1318 @@
  * The format of this data is a vector of integer values which is the
  * concatenation of the contents list for all the meshsets.  The length
- * and format of the data for each set is stored in the set metatable.
+ * and format of the data for each set is stored in the set meta table.
  * See \ref mhdf_createSetMeta and \ref mhdf_SET_RANGE_BIT for a 
  * description of that data.
@@ -1346 +1346 @@
  * The format of this data is the concatenation of the lists of
  * global IDs of child sets for each set.  The order of the sets and
- * the number of children for each set is contained in the set metatable.
+ * the number of children for each set is contained in the set meta table.
  * (See \ref mhdf_createSetMeta ).
  *
@@ -1379 +1379 @@
 /** \brief Create file object for storing the set parent list 
  *
- * Create a data group for the list of set prents.  
+ * Create a data group for the list of set parents.  
  * The format of this data is the concatenation of the lists of
  * global IDs of parent sets for each set.  The order of the sets and
- * the number of parents for each set is contained in the set metatable.
+ * the number of parents for each set is contained in the set meta table.
  * (See \ref mhdf_createSetMeta ).
  *
@@ -1480 +1480 @@
  *
  * Sparse tag data is stored as a global table pair for each tag type.  The first
- * if the pair of tables is a list of Global IDs.  The second is the correspoding
+ * if the pair of tables is a list of Global IDs.  The second is the corresponding
  * tag value for each entity in the ID list.
  */
@@ -1508 +1508 @@
  * size. 
  *
- * This function is providied to allow converting the stored tag
+ * This function is provided to allow converting the stored tag
  * type in a file to the preferred type for it's representation 
  * in memory when reading tag values.
@@ -1589 +1589 @@
  *
  *\param file_handle      The file.
- *\param tag_name         The name of the tag to retreive the data for.
+ *\param tag_name         The name of the tag to retrieve the data for.
  *\param class_out        The TSTT class of the tag data.
  *\param size_out         Depends on value of class_out:
  *                        - mhdf_OPAQUE  - size of opaque data in bytes
  *                        - mhdf_BITFIELD - number of bits
- *                        - for everything else, if the tag dats is an
- *                          array, the length of the array.  1 otherwize.
- *\param tstt_storage_out The value of the TSTT enum for storage (dense, spase, etc.)
+ *                        - for everything else, if the tag data is an
+ *                          array, the length of the array.  1 otherwise.
+ *\param tstt_storage_out The value of the TSTT enum for storage (dense, sparse, etc.)
  *\param have_default_out Non-zero if file contains a default value for the tag.
  *\param have_global_out  Non-zero if the file contains a global/mesh value for the tag.
@@ -1637 +1637 @@
 /** \brief Check if the file contains dense tag data for the specified tag and element group.
  *
- * Check if there is dense tag data for a given element type for the specfiied
+ * Check if there is dense tag data for a given element type for the specified
  * tag.  
  *