diff options
Diffstat (limited to 'storage/xtradb/include/row0row.ic')
| -rw-r--r-- | storage/xtradb/include/row0row.ic | 41 |
1 files changed, 21 insertions, 20 deletions
diff --git a/storage/xtradb/include/row0row.ic b/storage/xtradb/include/row0row.ic index 9947dd43257..05c007641af 100644 --- a/storage/xtradb/include/row0row.ic +++ b/storage/xtradb/include/row0row.ic @@ -16,7 +16,8 @@ Place, Suite 330, Boston, MA 02111-1307 USA *****************************************************************************/ -/****************************************************** +/**************************************************//** +@file include/row0row.ic General row routines Created 4/20/1996 Heikki Tuuri @@ -26,16 +27,16 @@ Created 4/20/1996 Heikki Tuuri #include "rem0rec.h" #include "trx0undo.h" -/************************************************************************* -Reads the trx id field from a clustered index record. */ +/*********************************************************************//** +Reads the trx id field from a clustered index record. +@return value of the field */ UNIV_INLINE -dulint +trx_id_t row_get_rec_trx_id( /*===============*/ - /* out: value of the field */ - const rec_t* rec, /* in: record */ - dict_index_t* index, /* in: clustered index */ - const ulint* offsets)/* in: rec_get_offsets(rec, index) */ + const rec_t* rec, /*!< in: record */ + dict_index_t* index, /*!< in: clustered index */ + const ulint* offsets)/*!< in: rec_get_offsets(rec, index) */ { ulint offset; @@ -51,16 +52,16 @@ row_get_rec_trx_id( return(trx_read_trx_id(rec + offset)); } -/************************************************************************* -Reads the roll pointer field from a clustered index record. */ +/*********************************************************************//** +Reads the roll pointer field from a clustered index record. +@return value of the field */ UNIV_INLINE -dulint +roll_ptr_t row_get_rec_roll_ptr( /*=================*/ - /* out: value of the field */ - const rec_t* rec, /* in: record */ - dict_index_t* index, /* in: clustered index */ - const ulint* offsets)/* in: rec_get_offsets(rec, index) */ + const rec_t* rec, /*!< in: record */ + dict_index_t* index, /*!< in: clustered index */ + const ulint* offsets)/*!< in: rec_get_offsets(rec, index) */ { ulint offset; @@ -76,22 +77,22 @@ row_get_rec_roll_ptr( return(trx_read_roll_ptr(rec + offset + DATA_TRX_ID_LEN)); } -/*********************************************************************** +/*******************************************************************//** Builds from a secondary index record a row reference with which we can search the clustered index record. */ UNIV_INLINE void row_build_row_ref_fast( /*===================*/ - dtuple_t* ref, /* in/out: typed data tuple where the + dtuple_t* ref, /*!< in/out: typed data tuple where the reference is built */ - const ulint* map, /* in: array of field numbers in rec + const ulint* map, /*!< in: array of field numbers in rec telling how ref should be built from the fields of rec */ - const rec_t* rec, /* in: record in the index; must be + const rec_t* rec, /*!< in: record in the index; must be preserved while ref is used, as we do not copy field values to heap */ - const ulint* offsets)/* in: array returned by rec_get_offsets() */ + const ulint* offsets)/*!< in: array returned by rec_get_offsets() */ { dfield_t* dfield; const byte* field; |