bzr commit into mysql-6.0-runtime branch (alik:2782)

[Alexander Nozdrin]

#At file:///mnt/raid/alik/MySQL/bzr/wl4264/6.0-alik-wl4264.1/

 2782 Alexander Nozdrin	2008-12-02
      Add doxygen comments.
modified:
  sql/si_objects.cc

=== modified file 'sql/si_objects.cc'
--- a/sql/si_objects.cc	2008-12-02 09:50:18 +0000
+++ b/sql/si_objects.cc	2008-12-02 10:02:24 +0000
@@ -214,6 +214,11 @@ void copy_warnings(THD *thd, List<MYSQL_
 ///////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////
 
+/**
+  Table_name_key defines a hash key, which includes database and tables
+  names.
+*/
+
 struct Table_name_key
 {
 public:
@@ -270,6 +275,11 @@ free_table_name_key(void *data)
 ///////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////
 
+/**
+  Int_value is a wrapper for unsigned long type to be used with
+  the String_stream class.
+*/
+
 struct Int_value
 {
   unsigned long m_value;
@@ -281,6 +291,11 @@ struct Int_value
 
 ///////////////////////////////////////////////////////////////////////////
 
+/*
+  C_str is a wrapper for C-string (const char *) to be used with the
+  String_stream class.
+*/
+
 struct C_str
 {
   LEX_STRING lex_string;
@@ -294,6 +309,14 @@ struct C_str
 
 ///////////////////////////////////////////////////////////////////////////
 
+/**
+  @class String_stream
+
+  This class provides a convenient way to create a dynamic string from
+  C-strings in different forms (LEX_STRING, const char *) and integer
+  constants.
+*/
+
 class String_stream
 {
 public:
@@ -363,6 +386,23 @@ String_stream &String_stream::operator <
 ///////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////
 
+/**
+  @class Out_stream
+
+  This class encapsulates the semantic of creating the serialization image.
+  The image is actually a list of strings. Strings may contain any data
+  (including binary and new-line characters). String is length-coded, which
+  means there is string length before the string data.
+
+  The format is as follows:
+    <string length> <space> <string data> \n
+
+  Example:
+    12 Hello,
+    world
+    5 qwerty
+*/
+
 class Out_stream
 {
 public:
@@ -409,6 +449,13 @@ Out_stream &Out_stream::operator <<(cons
 ///////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////
 
+/**
+  @class In_stream
+
+  This class encapsulates the semantic of reading from the serialization image.
+  For the format definition of the serialization image, @see Out_stream.
+*/
+
 class In_stream
 {
 public:
@@ -464,6 +511,13 @@ bool In_stream::next(LEX_STRING *chunk)
 
 ///////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////
+
+/**
+  @class Grant_id_provider
+
+  This is a tool to generate unique identifiers for Grant instances in a
+  thread-safe way.
+*/
 
 class Grant_id_provider
 {