summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--sql/event_data_objects.cc8
-rw-r--r--sql/event_data_objects.h9
-rw-r--r--sql/event_db_repository.cc9
-rw-r--r--sql/event_db_repository.h13
-rw-r--r--sql/event_queue.cc8
-rw-r--r--sql/event_queue.h17
-rw-r--r--sql/event_scheduler.cc9
-rw-r--r--sql/event_scheduler.h18
-rw-r--r--sql/events.cc9
-rw-r--r--sql/events.h9
-rw-r--r--sql/lock.cc9
-rw-r--r--sql/sp_head.h9
-rw-r--r--sql/sql_base.cc7
-rw-r--r--sql/sql_lex.h7
-rw-r--r--sql/sql_parse.cc9
-rw-r--r--sql/sql_select.cc8
-rw-r--r--sql/sql_yacc.yy8
17 files changed, 157 insertions, 9 deletions
diff --git a/sql/event_data_objects.cc b/sql/event_data_objects.cc
index 2ab77ad6b11..787b04c12c6 100644
--- a/sql/event_data_objects.cc
+++ b/sql/event_data_objects.cc
@@ -20,6 +20,10 @@
#include "event_db_repository.h"
#include "sp_head.h"
+/**
+ @addtogroup Event_Scheduler
+ @{
+*/
#define EVEX_MAX_INTERVAL_VALUE 1000000000L
@@ -2082,3 +2086,7 @@ event_basic_identifier_equal(LEX_STRING db, LEX_STRING name, Event_basic *b)
return !sortcmp_lex_string(name, b->name, system_charset_info) &&
!sortcmp_lex_string(db, b->dbname, system_charset_info);
}
+
+/**
+ @} (End of group Event_Scheduler)
+*/
diff --git a/sql/event_data_objects.h b/sql/event_data_objects.h
index a8e7d1720ca..7a49d1597d6 100644
--- a/sql/event_data_objects.h
+++ b/sql/event_data_objects.h
@@ -15,6 +15,12 @@
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */
+/**
+ @addtogroup Event_Scheduler
+ @{
+
+ @file event_data_objects.h
+*/
#define EVEX_GET_FIELD_FAILED -2
#define EVEX_BAD_PARAMS -5
@@ -280,5 +286,8 @@ event_basic_db_equal(LEX_STRING db, Event_basic *et);
bool
event_basic_identifier_equal(LEX_STRING db, LEX_STRING name, Event_basic *b);
+/**
+ @} (End of group Event_Scheduler)
+*/
#endif /* _EVENT_DATA_OBJECTS_H_ */
diff --git a/sql/event_db_repository.cc b/sql/event_db_repository.cc
index 96c01ad9a0e..37afbabad43 100644
--- a/sql/event_db_repository.cc
+++ b/sql/event_db_repository.cc
@@ -20,6 +20,11 @@
#include "events.h"
#include "sql_show.h"
+/**
+ @addtogroup Event_Scheduler
+ @{
+*/
+
static
const TABLE_FIELD_W_TYPE event_table_fields[ET_FIELD_COUNT] =
{
@@ -1112,3 +1117,7 @@ Event_db_repository::check_system_tables(THD *thd)
DBUG_RETURN(test(ret));
}
+
+/**
+ @} (End of group Event_Scheduler)
+*/
diff --git a/sql/event_db_repository.h b/sql/event_db_repository.h
index b60d2ea7afc..ef778407d1e 100644
--- a/sql/event_db_repository.h
+++ b/sql/event_db_repository.h
@@ -15,8 +15,14 @@
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */
-/*
- @file
+/**
+ @addtogroup Event_Scheduler
+ @{
+
+ @file event_db_repository.h
+
+ Data Dictionary related operations of Event Scheduler.
+
This is a private header file of Events module. Please do not include it
directly. All public declarations of Events module should be stored in
events.h and event_data_objects.h.
@@ -119,4 +125,7 @@ private:
void operator=(Event_db_repository &);
};
+/**
+ @} (End of group Event_Scheduler)
+*/
#endif /* _EVENT_DB_REPOSITORY_H_ */
diff --git a/sql/event_queue.cc b/sql/event_queue.cc
index 95f207844fc..71ae5c7652f 100644
--- a/sql/event_queue.cc
+++ b/sql/event_queue.cc
@@ -17,6 +17,10 @@
#include "event_queue.h"
#include "event_data_objects.h"
+/**
+ @addtogroup Event_Scheduler
+ @{
+*/
#define EVENT_QUEUE_INITIAL_SIZE 30
#define EVENT_QUEUE_EXTENT 30
@@ -749,3 +753,7 @@ Event_queue::dump_internal_status()
DBUG_VOID_RETURN;
}
+
+/**
+ @} (End of group Event_Scheduler)
+*/
diff --git a/sql/event_queue.h b/sql/event_queue.h
index ac4a4f2bfd7..2870ecb4d0b 100644
--- a/sql/event_queue.h
+++ b/sql/event_queue.h
@@ -15,12 +15,26 @@
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */
+/**
+
+ @addtogroup Event_Scheduler
+ @{
+
+ @file event_queue.h
+
+ Queue of events awaiting execution.
+*/
+
class Event_basic;
class Event_queue_element;
class Event_queue_element_for_exec;
class THD;
+/**
+ Queue of active events awaiting execution.
+*/
+
class Event_queue
{
public:
@@ -105,5 +119,8 @@ private:
bool mutex_queue_data_attempting_lock;
bool waiting_on_cond;
};
+/**
+ @} (End of group Event_Scheduler)
+*/
#endif /* _EVENT_QUEUE_H_ */
diff --git a/sql/event_scheduler.cc b/sql/event_scheduler.cc
index 3092521fd4c..b03b51f1134 100644
--- a/sql/event_scheduler.cc
+++ b/sql/event_scheduler.cc
@@ -20,6 +20,11 @@
#include "event_queue.h"
#include "event_db_repository.h"
+/**
+ @addtogroup Event_Scheduler
+ @{
+*/
+
#ifdef __GNUC__
#if __GNUC__ >= 2
#define SCHED_FUNC __FUNCTION__
@@ -790,3 +795,7 @@ Event_scheduler::dump_internal_status()
DBUG_VOID_RETURN;
}
+
+/**
+ @} (End of group Event_Scheduler)
+*/
diff --git a/sql/event_scheduler.h b/sql/event_scheduler.h
index eba66c68d42..0be93a65d33 100644
--- a/sql/event_scheduler.h
+++ b/sql/event_scheduler.h
@@ -16,10 +16,18 @@
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */
/**
+ @addtogroup Event_Scheduler
+ @{
+*/
+/**
@file
- This file is internal to Events module. Please do not include it directly.
- All public declarations of Events module are in events.h and
- event_data_objects.h.
+
+ Declarations of the scheduler thread class
+ and related functionality.
+
+ This file is internal to Event_Scheduler module. Please do not
+ include it directly. All public declarations of Event_Scheduler
+ module are in events.h and event_data_objects.h.
*/
@@ -140,4 +148,8 @@ private:
void operator=(Event_scheduler &);
};
+/**
+ @} (End of group Event_Scheduler)
+*/
+
#endif /* _EVENT_SCHEDULER_H_ */
diff --git a/sql/events.cc b/sql/events.cc
index bdb9512647f..5246bccc388 100644
--- a/sql/events.cc
+++ b/sql/events.cc
@@ -21,6 +21,11 @@
#include "event_scheduler.h"
#include "sp_head.h" // for Stored_program_creation_ctx
+/**
+ @addtogroup Event_Scheduler
+ @{
+*/
+
/*
TODO list :
- CREATE EVENT should not go into binary log! Does it now? The SQL statements
@@ -1186,3 +1191,7 @@ end:
DBUG_RETURN(ret);
}
+
+/**
+ @} (End of group Event_Scheduler)
+*/
diff --git a/sql/events.h b/sql/events.h
index 078ab63041b..2bc87517748 100644
--- a/sql/events.h
+++ b/sql/events.h
@@ -16,10 +16,13 @@
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */
/**
- @file
- A public interface of Events Scheduler module.
- @defgroup Event Scheduler
+ @defgroup Event_Scheduler Event Scheduler
+ @ingroup Runtime_Environment
@{
+
+ @file events.h
+
+ A public interface of Events_Scheduler module.
*/
class Event_parse_data;
diff --git a/sql/lock.cc b/sql/lock.cc
index 8b98c2303a8..f859f028504 100644
--- a/sql/lock.cc
+++ b/sql/lock.cc
@@ -74,6 +74,11 @@ TODO:
#include <hash.h>
#include <assert.h>
+/**
+ @defgroup Locking Locking
+ @{
+*/
+
extern HASH open_cache;
/* flags for get_lock_data */
@@ -1590,4 +1595,6 @@ void broadcast_refresh(void)
VOID(pthread_cond_broadcast(&COND_global_read_lock));
}
-
+/**
+ @} (end of group Locking)
+*/
diff --git a/sql/sp_head.h b/sql/sp_head.h
index 41cf8167376..3a8b41acd4c 100644
--- a/sql/sp_head.h
+++ b/sql/sp_head.h
@@ -23,6 +23,11 @@
#include <stddef.h>
+/**
+ @defgroup Stored_Routines Stored Routines
+ @ingroup Runtime_Environment
+ @{
+*/
// Values for the type enum. This reflects the order of the enum declaration
// in the CREATE TABLE command.
#define TYPE_ENUM_FUNCTION 1
@@ -1322,4 +1327,8 @@ sp_prepare_func_item(THD* thd, Item **it_addr);
bool
sp_eval_expr(THD *thd, Field *result_field, Item **expr_item_ptr);
+/**
+ @} (end of group Stored_Routines)
+*/
+
#endif /* _SP_HEAD_H_ */
diff --git a/sql/sql_base.cc b/sql/sql_base.cc
index cdec96a8526..e15bc1c3137 100644
--- a/sql/sql_base.cc
+++ b/sql/sql_base.cc
@@ -82,6 +82,10 @@ bool Prelock_error_handler::safely_trapped_errors()
return ((m_handled_errors > 0) && (m_unhandled_errors == 0));
}
+/**
+ @defgroup Data_Dictionary Data Dictionary
+ @{
+*/
TABLE *unused_tables; /* Used by mysql_test */
HASH open_cache; /* Used by mysql_test */
@@ -7802,3 +7806,6 @@ void close_performance_schema_table(THD *thd, Open_tables_state *backup)
thd->restore_backup_open_tables_state(backup);
}
+/**
+ @} (end of group Data_Dictionary)
+*/
diff --git a/sql/sql_lex.h b/sql/sql_lex.h
index 94feddf6e77..22c7eb2ffb1 100644
--- a/sql/sql_lex.h
+++ b/sql/sql_lex.h
@@ -13,6 +13,9 @@
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */
+/**
+ @defgroup Semantic_Analysis Semantic Analysis
+*/
/* YACC and LEX Definitions */
@@ -1823,4 +1826,8 @@ extern void trim_whitespace(CHARSET_INFO *cs, LEX_STRING *str);
extern bool is_lex_native_function(const LEX_STRING *name);
+/**
+ @} (End of group Semantic_Analysis)
+*/
+
#endif /* MYSQL_SERVER */
diff --git a/sql/sql_parse.cc b/sql/sql_parse.cc
index cef551b812b..3e6218c5aa8 100644
--- a/sql/sql_parse.cc
+++ b/sql/sql_parse.cc
@@ -28,6 +28,11 @@
#include "events.h"
#include "sql_trigger.h"
+/**
+ @defgroup Runtime_Environment Runtime Environment
+ @{
+*/
+
/* Used in error handling only */
#define SP_TYPE_STRING(LP) \
((LP)->sphead->m_type == TYPE_ENUM_FUNCTION ? "FUNCTION" : "PROCEDURE")
@@ -7242,3 +7247,7 @@ bool parse_sql(THD *thd,
return err_status;
}
+
+/**
+ @} (end of group Runtime_Environment)
+*/
diff --git a/sql/sql_select.cc b/sql/sql_select.cc
index 0da3b4af547..14e5beada8b 100644
--- a/sql/sql_select.cc
+++ b/sql/sql_select.cc
@@ -13,6 +13,10 @@
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */
+/**
+ @defgroup Query_Optimizer Query Optimizer
+ @{
+*/
/* mysql_select and join optimization */
@@ -16037,3 +16041,7 @@ bool JOIN::change_result(select_result *res)
}
DBUG_RETURN(FALSE);
}
+
+/**
+ @} (end of group Query_Optimizer)
+*/
diff --git a/sql/sql_yacc.yy b/sql/sql_yacc.yy
index 3bbb3abaa54..8f66e41b338 100644
--- a/sql/sql_yacc.yy
+++ b/sql/sql_yacc.yy
@@ -15,6 +15,11 @@
/* sql_yacc.yy */
+/**
+ @defgroup Parser Parser
+ @{
+*/
+
%{
/* thd is passed as an argument to yyparse(), and subsequently to yylex().
** The type will be void*, so it must be cast to (THD*) when used.
@@ -12255,3 +12260,6 @@ uninstall:
}
;
+/**
+ @} (end of group Parser)
+*/