Merge XtraDB 8 into MariaDB.

1 files changed, 49 insertions, 51 deletions

diff --git a/storage/xtradb/include/dict0crea.h b/storage/xtradb/include/dict0crea.h
index 9ac3e408f1f..3107d771d88 100644
--- a/storage/xtradb/include/dict0crea.h
+++ b/storage/xtradb/include/dict0crea.h
@@ -16,7 +16,8 @@ Place, Suite 330, Boston, MA 02111-1307 USA
 
 *****************************************************************************/
 
-/******************************************************
+/**************************************************//**
+@file include/dict0crea.h
 Database object creation
 
 Created 1/8/1996 Heikki Tuuri
@@ -32,94 +33,92 @@ Created 1/8/1996 Heikki Tuuri
 #include "row0types.h"
 #include "mtr0mtr.h"
 
-/*************************************************************************
-Creates a table create graph. */
+/*********************************************************************//**
+Creates a table create graph.
+@return	own: table create node */
 UNIV_INTERN
 tab_node_t*
 tab_create_graph_create(
 /*====================*/
-				/* out, own: table create node */
-	dict_table_t*	table,	/* in: table to create, built as a memory data
+	dict_table_t*	table,	/*!< in: table to create, built as a memory data
 				structure */
-	mem_heap_t*	heap);	/* in: heap where created */
-/*************************************************************************
-Creates an index create graph. */
+	mem_heap_t*	heap);	/*!< in: heap where created */
+/*********************************************************************//**
+Creates an index create graph.
+@return	own: index create node */
 UNIV_INTERN
 ind_node_t*
 ind_create_graph_create(
 /*====================*/
-				/* out, own: index create node */
-	dict_index_t*	index,	/* in: index to create, built as a memory data
+	dict_index_t*	index,	/*!< in: index to create, built as a memory data
 				structure */
-	mem_heap_t*	heap);	/* in: heap where created */
-/***************************************************************
-Creates a table. This is a high-level function used in SQL execution graphs. */
+	mem_heap_t*	heap);	/*!< in: heap where created */
+/***********************************************************//**
+Creates a table. This is a high-level function used in SQL execution graphs.
+@return	query thread to run next or NULL */
 UNIV_INTERN
 que_thr_t*
 dict_create_table_step(
 /*===================*/
-				/* out: query thread to run next or NULL */
-	que_thr_t*	thr);	/* in: query thread */
-/***************************************************************
+	que_thr_t*	thr);	/*!< in: query thread */
+/***********************************************************//**
 Creates an index. This is a high-level function used in SQL execution
-graphs. */
+graphs.
+@return	query thread to run next or NULL */
 UNIV_INTERN
 que_thr_t*
 dict_create_index_step(
 /*===================*/
-				/* out: query thread to run next or NULL */
-	que_thr_t*	thr);	/* in: query thread */
-/***********************************************************************
-Truncates the index tree associated with a row in SYS_INDEXES table. */
+	que_thr_t*	thr);	/*!< in: query thread */
+/*******************************************************************//**
+Truncates the index tree associated with a row in SYS_INDEXES table.
+@return	new root page number, or FIL_NULL on failure */
 UNIV_INTERN
 ulint
 dict_truncate_index_tree(
 /*=====================*/
-				/* out: new root page number, or
-				FIL_NULL on failure */
-	dict_table_t*	table,	/* in: the table the index belongs to */
-	ulint		space,	/* in: 0=truncate,
+	dict_table_t*	table,	/*!< in: the table the index belongs to */
+	ulint		space,	/*!< in: 0=truncate,
 				nonzero=create the index tree in the
 				given tablespace */
-	btr_pcur_t*	pcur,	/* in/out: persistent cursor pointing to
+	btr_pcur_t*	pcur,	/*!< in/out: persistent cursor pointing to
 				record in the clustered index of
 				SYS_INDEXES table. The cursor may be
 				repositioned in this call. */
-	mtr_t*		mtr);	/* in: mtr having the latch
+	mtr_t*		mtr);	/*!< in: mtr having the latch
 				on the record page. The mtr may be
 				committed and restarted in this call. */
-/***********************************************************************
+/*******************************************************************//**
 Drops the index tree associated with a row in SYS_INDEXES table. */
 UNIV_INTERN
 void
 dict_drop_index_tree(
 /*=================*/
-	rec_t*	rec,	/* in/out: record in the clustered index
+	rec_t*	rec,	/*!< in/out: record in the clustered index
 			of SYS_INDEXES table */
-	mtr_t*	mtr);	/* in: mtr having the latch on the record page */
-#ifndef UNIV_HOTBACKUP
-/********************************************************************
+	mtr_t*	mtr);	/*!< in: mtr having the latch on the record page */
+/****************************************************************//**
 Creates the foreign key constraints system tables inside InnoDB
 at database creation or database start if they are not found or are
-not of the right form. */
+not of the right form.
+@return	DB_SUCCESS or error code */
 UNIV_INTERN
 ulint
 dict_create_or_check_foreign_constraint_tables(void);
 /*================================================*/
-				/* out: DB_SUCCESS or error code */
-/************************************************************************
+/********************************************************************//**
 Adds foreign key definitions to data dictionary tables in the database. We
 look at table->foreign_list, and also generate names to constraints that were
 not named by the user. A generated constraint has a name of the format
 databasename/tablename_ibfk_<number>, where the numbers start from 1, and are
 given locally for this table, that is, the number is not global, as in the
-old format constraints < 4.0.18 it used to be. */
+old format constraints < 4.0.18 it used to be.
+@return	error code or DB_SUCCESS */
 UNIV_INTERN
 ulint
 dict_create_add_foreigns_to_dictionary(
 /*===================================*/
-				/* out: error code or DB_SUCCESS */
-	ulint		start_id,/* in: if we are actually doing ALTER TABLE
+	ulint		start_id,/*!< in: if we are actually doing ALTER TABLE
 				ADD CONSTRAINT, we want to generate constraint
 				numbers which are bigger than in the table so
 				far; we number the constraints from
@@ -127,15 +126,14 @@ dict_create_add_foreigns_to_dictionary(
 				we are creating a new table, or if the table
 				so far has no constraints for which the name
 				was generated here */
-	dict_table_t*	table,	/* in: table */
-	trx_t*		trx);	/* in: transaction */
-#endif /* !UNIV_HOTBACKUP */
+	dict_table_t*	table,	/*!< in: table */
+	trx_t*		trx);	/*!< in: transaction */
 
 /* Table create node structure */
 
 struct tab_node_struct{
-	que_common_t	common;	/* node type: QUE_NODE_TABLE_CREATE */
-	dict_table_t*	table;	/* table to create, built as a memory data
+	que_common_t	common;	/*!< node type: QUE_NODE_TABLE_CREATE */
+	dict_table_t*	table;	/*!< table to create, built as a memory data
 				structure with dict_mem_... functions */
 	ins_node_t*	tab_def; /* child node which does the insert of
 				the table definition; the row to be inserted
@@ -148,9 +146,9 @@ struct tab_node_struct{
 				a successful table creation */
 	/*----------------------*/
 	/* Local storage for this graph node */
-	ulint		state;	/* node execution state */
-	ulint		col_no;	/* next column definition to insert */
-	mem_heap_t*	heap;	/* memory heap used as auxiliary storage */
+	ulint		state;	/*!< node execution state */
+	ulint		col_no;	/*!< next column definition to insert */
+	mem_heap_t*	heap;	/*!< memory heap used as auxiliary storage */
 };
 
 /* Table create node states */
@@ -163,8 +161,8 @@ struct tab_node_struct{
 /* Index create node struct */
 
 struct ind_node_struct{
-	que_common_t	common;	/* node type: QUE_NODE_INDEX_CREATE */
-	dict_index_t*	index;	/* index to create, built as a memory data
+	que_common_t	common;	/*!< node type: QUE_NODE_INDEX_CREATE */
+	dict_index_t*	index;	/*!< index to create, built as a memory data
 				structure with dict_mem_... functions */
 	ins_node_t*	ind_def; /* child node which does the insert of
 				the index definition; the row to be inserted
@@ -177,12 +175,12 @@ struct ind_node_struct{
 				a successful index creation */
 	/*----------------------*/
 	/* Local storage for this graph node */
-	ulint		state;	/* node execution state */
+	ulint		state;	/*!< node execution state */
 	ulint		page_no;/* root page number of the index */
-	dict_table_t*	table;	/* table which owns the index */
+	dict_table_t*	table;	/*!< table which owns the index */
 	dtuple_t*	ind_row;/* index definition row built */
 	ulint		field_no;/* next field definition to insert */
-	mem_heap_t*	heap;	/* memory heap used as auxiliary storage */
+	mem_heap_t*	heap;	/*!< memory heap used as auxiliary storage */
 };
 
 /* Index create node states */