From 94e41712130a838e72876785d880e62dbda6ca0c Mon Sep 17 00:00:00 2001 From: unknown Date: Tue, 16 Oct 2007 16:11:50 -0400 Subject: Doxygenize comments. --- sql/sql_select.h | 133 +++++++++++++++++++++++++++++-------------------------- 1 file changed, 69 insertions(+), 64 deletions(-) (limited to 'sql/sql_select.h') diff --git a/sql/sql_select.h b/sql/sql_select.h index efa92432e2b..f91a965d4ac 100644 --- a/sql/sql_select.h +++ b/sql/sql_select.h @@ -14,7 +14,12 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ -/* classes to use when handling where clause */ +/** + @file + + @brief + classes to use when handling where clause +*/ #ifdef USE_PRAGMA_INTERFACE #pragma interface /* gcc class implementation */ @@ -25,12 +30,12 @@ typedef struct keyuse_t { TABLE *table; - Item *val; /* or value if no field */ + Item *val; /**< or value if no field */ table_map used_tables; uint key, keypart, optimize; key_part_map keypart_map; ha_rows ref_table_rows; - /* + /** If true, the comparison this value was created from will not be satisfied if val has NULL 'value'. */ @@ -53,13 +58,13 @@ class store_key; typedef struct st_table_ref { bool key_err; - uint key_parts; // num of ... - uint key_length; // length of key_buff - int key; // key no - uchar *key_buff; // value to look for with key - uchar *key_buff2; // key_buff+key_length + uint key_parts; ///< num of ... + uint key_length; ///< length of key_buff + int key; ///< key no + uchar *key_buff; ///< value to look for with key + uchar *key_buff2; ///< key_buff+key_length store_key **key_copy; // - Item **items; // val()'s for each keypart + Item **items; ///< val()'s for each keypart /* Array of pointers to trigger variables. Some/all of the pointers may be NULL. The ref access can be used iff @@ -72,18 +77,18 @@ typedef struct st_table_ref underlying conditions is switched off (see subquery code for more details) */ bool **cond_guards; - /* + /** (null_rejecting & (1< *fields; List group_fields, group_fields_cache; TABLE *tmp_table; - // used to store 2 possible tmp table of SELECT + /// used to store 2 possible tmp table of SELECT TABLE *exec_tmp_table1, *exec_tmp_table2; THD *thd; Item_sum **sum_funcs, ***sum_funcs_end; - /* second copy of sumfuncs (for queries with 2 temporary tables */ + /** second copy of sumfuncs (for queries with 2 temporary tables */ Item_sum **sum_funcs2, ***sum_funcs_end2; Procedure *procedure; Item *having; - Item *tmp_having; // To store having when processed temporary table - Item *having_history; // Store having for explain + Item *tmp_having; ///< To store having when processed temporary table + Item *having_history; ///< Store having for explain ulonglong select_options; select_result *result; TMP_TABLE_PARAM tmp_table_param; MYSQL_LOCK *lock; - // unit structure (with global parameters) for this select + /// unit structure (with global parameters) for this select SELECT_LEX_UNIT *unit; - // select that processed + /// select that processed SELECT_LEX *select_lex; - /* + /** TRUE <=> optimizer must not mark any table as a constant table. This is needed for subqueries in form "a IN (SELECT .. UNION SELECT ..): when we optimize the select that reads the results of the union from a @@ -331,11 +336,11 @@ public: */ bool no_const_tables; - JOIN *tmp_join; // copy of this JOIN to be used with temporary tables - ROLLUP rollup; // Used with rollup + JOIN *tmp_join; ///< copy of this JOIN to be used with temporary tables + ROLLUP rollup; ///< Used with rollup - bool select_distinct; // Set if SELECT DISTINCT - /* + bool select_distinct; ///< Set if SELECT DISTINCT + /** If we have the GROUP BY statement in the query, but the group_list was emptied by optimizer, this flag is TRUE. @@ -350,42 +355,42 @@ public: It's also set if ORDER/GROUP BY is empty. */ bool simple_order, simple_group; - /* + /** Is set only in case if we have a GROUP BY clause and no ORDER BY after constant elimination of 'order'. */ bool no_order; - /* Is set if we have a GROUP BY and we have ORDER BY on a constant. */ + /** Is set if we have a GROUP BY and we have ORDER BY on a constant. */ bool skip_sort_order; bool need_tmp, hidden_group_fields; DYNAMIC_ARRAY keyuse; Item::cond_result cond_value, having_value; - List all_fields; // to store all fields that used in query - //Above list changed to use temporary table + List all_fields; ///< to store all fields that used in query + ///Above list changed to use temporary table List tmp_all_fields1, tmp_all_fields2, tmp_all_fields3; - //Part, shared with list above, emulate following list + ///Part, shared with list above, emulate following list List tmp_fields_list1, tmp_fields_list2, tmp_fields_list3; - List &fields_list; // hold field list passed to mysql_select + List &fields_list; ///< hold field list passed to mysql_select List procedure_fields_list; int error; ORDER *order, *group_list, *proc_param; //hold parameters of mysql_select COND *conds; // ---"--- Item *conds_history; // store WHERE for explain - TABLE_LIST *tables_list; //hold 'tables' parameter of mysql_select - List *join_list; // list of joined tables in reverse order + TABLE_LIST *tables_list; /// *join_list; ///< list of joined tables in reverse order COND_EQUAL *cond_equal; - SQL_SELECT *select; //created in optimisation phase - JOIN_TAB *return_tab; //used only for outer joins - Item **ref_pointer_array; //used pointer reference for this select + SQL_SELECT *select; /// &all_fields,COND *conds); /* from sql_delete.cc, used by opt_range.cc */ extern "C" int refpos_order_cmp(void* arg, const void *a,const void *b); -/* class to copying an field/item to a key struct */ +/** class to copying an field/item to a key struct */ class store_key :public Sql_alloc { @@ -578,7 +583,7 @@ public: to_field=field_arg->new_key_field(thd->mem_root, field_arg->table, ptr, null, 1); } - virtual ~store_key() {} /* Not actually needed */ + virtual ~store_key() {} /** Not actually needed */ virtual const char *name() const=0; /** -- cgit v1.2.1