Merge XtraDB 8 into MariaDB.

1 files changed, 57 insertions, 54 deletions

diff --git a/storage/xtradb/include/dyn0dyn.ic b/storage/xtradb/include/dyn0dyn.ic
index 1ef8b284a99..110e674abff 100644
--- a/storage/xtradb/include/dyn0dyn.ic
+++ b/storage/xtradb/include/dyn0dyn.ic
@@ -16,43 +16,46 @@ Place, Suite 330, Boston, MA 02111-1307 USA
 
 *****************************************************************************/
 
-/******************************************************
+/**************************************************//**
+@file include/dyn0dyn.ic
 The dynamically allocated array
 
 Created 2/5/1996 Heikki Tuuri
 *******************************************************/
 
+/** Value of dyn_block_struct::magic_n */
 #define DYN_BLOCK_MAGIC_N	375767
+/** Flag for dyn_block_struct::used that indicates a full block */
 #define DYN_BLOCK_FULL_FLAG	0x1000000UL
 
-/****************************************************************
-Adds a new block to a dyn array. */
+/************************************************************//**
+Adds a new block to a dyn array.
+@return	created block */
 UNIV_INTERN
 dyn_block_t*
 dyn_array_add_block(
 /*================*/
-				/* out: created block */
-	dyn_array_t*	arr);	/* in: dyn array */
+	dyn_array_t*	arr);	/*!< in: dyn array */
 
 
-/****************************************************************
+/************************************************************//**
 Gets the first block in a dyn array. */
 UNIV_INLINE
 dyn_block_t*
 dyn_array_get_first_block(
 /*======================*/
-	dyn_array_t*	arr)	/* in: dyn array */
+	dyn_array_t*	arr)	/*!< in: dyn array */
 {
 	return(arr);
 }
 
-/****************************************************************
+/************************************************************//**
 Gets the last block in a dyn array. */
 UNIV_INLINE
 dyn_block_t*
 dyn_array_get_last_block(
 /*=====================*/
-	dyn_array_t*	arr)	/* in: dyn array */
+	dyn_array_t*	arr)	/*!< in: dyn array */
 {
 	if (arr->heap == NULL) {
 
@@ -62,15 +65,15 @@ dyn_array_get_last_block(
 	return(UT_LIST_GET_LAST(arr->base));
 }
 
-/************************************************************************
-Gets the next block in a dyn array. */
+/********************************************************************//**
+Gets the next block in a dyn array.
+@return	pointer to next, NULL if end of list */
 UNIV_INLINE
 dyn_block_t*
 dyn_array_get_next_block(
 /*=====================*/
-				/* out: pointer to next, NULL if end of list */
-	dyn_array_t*	arr,	/* in: dyn array */
-	dyn_block_t*	block)	/* in: dyn array block */
+	dyn_array_t*	arr,	/*!< in: dyn array */
+	dyn_block_t*	block)	/*!< in: dyn array block */
 {
 	ut_ad(arr && block);
 
@@ -83,42 +86,42 @@ dyn_array_get_next_block(
 	return(UT_LIST_GET_NEXT(list, block));
 }
 
-/************************************************************************
-Gets the number of used bytes in a dyn array block. */
+/********************************************************************//**
+Gets the number of used bytes in a dyn array block.
+@return	number of bytes used */
 UNIV_INLINE
 ulint
 dyn_block_get_used(
 /*===============*/
-				/* out: number of bytes used */
-	dyn_block_t*	block)	/* in: dyn array block */
+	dyn_block_t*	block)	/*!< in: dyn array block */
 {
 	ut_ad(block);
 
 	return((block->used) & ~DYN_BLOCK_FULL_FLAG);
 }
 
-/************************************************************************
-Gets pointer to the start of data in a dyn array block. */
+/********************************************************************//**
+Gets pointer to the start of data in a dyn array block.
+@return	pointer to data */
 UNIV_INLINE
 byte*
 dyn_block_get_data(
 /*===============*/
-				/* out: pointer to data */
-	dyn_block_t*	block)	/* in: dyn array block */
+	dyn_block_t*	block)	/*!< in: dyn array block */
 {
 	ut_ad(block);
 
 	return(block->data);
 }
 
-/*************************************************************************
-Initializes a dynamic array. */
+/*********************************************************************//**
+Initializes a dynamic array.
+@return	initialized dyn array */
 UNIV_INLINE
 dyn_array_t*
 dyn_array_create(
 /*=============*/
-				/* out: initialized dyn array */
-	dyn_array_t*	arr)	/* in: pointer to a memory buffer of
+	dyn_array_t*	arr)	/*!< in: pointer to a memory buffer of
 				size sizeof(dyn_array_t) */
 {
 	ut_ad(arr);
@@ -136,13 +139,13 @@ dyn_array_create(
 	return(arr);
 }
 
-/****************************************************************
+/************************************************************//**
 Frees a dynamic array. */
 UNIV_INLINE
 void
 dyn_array_free(
 /*===========*/
-	dyn_array_t*	arr)	/* in: dyn array */
+	dyn_array_t*	arr)	/*!< in: dyn array */
 {
 	if (arr->heap != NULL) {
 		mem_heap_free(arr->heap);
@@ -153,16 +156,16 @@ dyn_array_free(
 #endif
 }
 
-/*************************************************************************
+/*********************************************************************//**
 Makes room on top of a dyn array and returns a pointer to the added element.
-The caller must copy the element to the pointer returned. */
+The caller must copy the element to the pointer returned.
+@return	pointer to the element */
 UNIV_INLINE
 void*
 dyn_array_push(
 /*===========*/
-				/* out: pointer to the element */
-	dyn_array_t*	arr,	/* in: dynamic array */
-	ulint		size)	/* in: size in bytes of the element */
+	dyn_array_t*	arr,	/*!< in: dynamic array */
+	ulint		size)	/*!< in: size in bytes of the element */
 {
 	dyn_block_t*	block;
 	ulint		used;
@@ -193,17 +196,17 @@ dyn_array_push(
 	return((block->data) + used);
 }
 
-/*************************************************************************
+/*********************************************************************//**
 Makes room on top of a dyn array and returns a pointer to a buffer in it.
 After copying the elements, the caller must close the buffer using
-dyn_array_close. */
+dyn_array_close.
+@return	pointer to the buffer */
 UNIV_INLINE
 byte*
 dyn_array_open(
 /*===========*/
-				/* out: pointer to the buffer */
-	dyn_array_t*	arr,	/* in: dynamic array */
-	ulint		size)	/* in: size in bytes of the buffer; MUST be
+	dyn_array_t*	arr,	/*!< in: dynamic array */
+	ulint		size)	/*!< in: size in bytes of the buffer; MUST be
 				smaller than DYN_ARRAY_DATA_SIZE! */
 {
 	dyn_block_t*	block;
@@ -239,14 +242,14 @@ dyn_array_open(
 	return((block->data) + used);
 }
 
-/*************************************************************************
+/*********************************************************************//**
 Closes the buffer returned by dyn_array_open. */
 UNIV_INLINE
 void
 dyn_array_close(
 /*============*/
-	dyn_array_t*	arr,	/* in: dynamic array */
-	byte*		ptr)	/* in: buffer space from ptr up was not used */
+	dyn_array_t*	arr,	/*!< in: dynamic array */
+	byte*		ptr)	/*!< in: buffer space from ptr up was not used */
 {
 	dyn_block_t*	block;
 
@@ -266,15 +269,15 @@ dyn_array_close(
 #endif
 }
 
-/****************************************************************
-Returns pointer to an element in dyn array. */
+/************************************************************//**
+Returns pointer to an element in dyn array.
+@return	pointer to element */
 UNIV_INLINE
 void*
 dyn_array_get_element(
 /*==================*/
-				/* out: pointer to element */
-	dyn_array_t*	arr,	/* in: dyn array */
-	ulint		pos)	/* in: position of element as bytes
+	dyn_array_t*	arr,	/*!< in: dyn array */
+	ulint		pos)	/*!< in: position of element as bytes
 				from array start */
 {
 	dyn_block_t*	block;
@@ -304,14 +307,14 @@ dyn_array_get_element(
 	return(block->data + pos);
 }
 
-/****************************************************************
-Returns the size of stored data in a dyn array. */
+/************************************************************//**
+Returns the size of stored data in a dyn array.
+@return	data size in bytes */
 UNIV_INLINE
 ulint
 dyn_array_get_data_size(
 /*====================*/
-				/* out: data size in bytes */
-	dyn_array_t*	arr)	/* in: dyn array */
+	dyn_array_t*	arr)	/*!< in: dyn array */
 {
 	dyn_block_t*	block;
 	ulint		sum	= 0;
@@ -335,15 +338,15 @@ dyn_array_get_data_size(
 	return(sum);
 }
 
-/************************************************************
+/********************************************************//**
 Pushes n bytes to a dyn array. */
 UNIV_INLINE
 void
 dyn_push_string(
 /*============*/
-	dyn_array_t*	arr,	/* in: dyn array */
-	const byte*	str,	/* in: string to write */
-	ulint		len)	/* in: string length */
+	dyn_array_t*	arr,	/*!< in: dyn array */
+	const byte*	str,	/*!< in: string to write */
+	ulint		len)	/*!< in: string length */
 {
 	ulint	n_copied;