summaryrefslogtreecommitdiff
path: root/sql/sql_cursor.h
diff options
context:
space:
mode:
authorunknown <cmiller@zippy.cornsilk.net>2007-10-16 16:11:50 -0400
committerunknown <cmiller@zippy.cornsilk.net>2007-10-16 16:11:50 -0400
commit94e41712130a838e72876785d880e62dbda6ca0c (patch)
tree8b9e521083780437237f38683ce7cab9518c7e78 /sql/sql_cursor.h
parent4a0ec7864ea5c97bb51954c26674f1b6db04b13f (diff)
downloadmariadb-git-94e41712130a838e72876785d880e62dbda6ca0c.tar.gz
Doxygenize comments.
Diffstat (limited to 'sql/sql_cursor.h')
-rw-r--r--sql/sql_cursor.h11
1 files changed, 6 insertions, 5 deletions
diff --git a/sql/sql_cursor.h b/sql/sql_cursor.h
index 6edd6b24b36..1f19cbfdbcf 100644
--- a/sql/sql_cursor.h
+++ b/sql/sql_cursor.h
@@ -20,12 +20,14 @@
#pragma interface /* gcc class interface */
#endif
-/*
+/**
+ @file
+
Declarations for implementation of server side cursors. Only
read-only non-scrollable cursors are currently implemented.
*/
-/*
+/**
Server_side_cursor -- an interface for materialized and
sensitive (non-materialized) implementation of cursors. All
cursors are self-contained (created in their own memory root).
@@ -36,7 +38,7 @@
class Server_side_cursor: protected Query_arena, public Sql_alloc
{
protected:
- /* Row destination used for fetch */
+ /** Row destination used for fetch */
select_result *result;
public:
Server_side_cursor(MEM_ROOT *mem_root_arg, select_result *result_arg)
@@ -58,8 +60,7 @@ int mysql_open_cursor(THD *thd, uint flags,
select_result *result,
Server_side_cursor **res);
-/* Possible values for flags */
-
+/** Possible values for flags */
enum { ANY_CURSOR= 1, ALWAYS_MATERIALIZED_CURSOR= 2 };
#endif /* _sql_cusor_h_ */