Commit d43c15b0 authored by unknown's avatar unknown

Doxygenization of comments.

parent 39062b7e
......@@ -14,11 +14,15 @@
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */
/*
/**
@file
@brief
Functions to copy data to or from fields
This could be done with a single short function but opencoding this
gives much more speed.
*/
*/
#include "mysql_priv.h"
#include <m_ctype.h>
......@@ -129,20 +133,19 @@ set_field_to_null(Field *field)
}
/*
Set field to NULL or TIMESTAMP or to next auto_increment number
/**
Set field to NULL or TIMESTAMP or to next auto_increment number.
SYNOPSIS
set_field_to_null_with_conversions()
field Field to update
no_conversion Set to 1 if we should return 1 if field can't
@param field Field to update
@param no_conversions Set to 1 if we should return 1 if field can't
take null values.
If set to 0 we will do store the 'default value'
if the field is a special field. If not we will
give an error.
RETURN VALUES
@retval
0 Field could take 0 or an automatic conversion was used
@retval
-1 Field could not take NULL and no conversion was used.
If no_conversion was not set, an error message is printed
*/
......@@ -283,7 +286,7 @@ static void do_conv_blob(Copy_field *copy)
copy->tmp.charset());
}
/* Save blob in copy->tmp for GROUP BY */
/** Save blob in copy->tmp for GROUP BY. */
static void do_save_blob(Copy_field *copy)
{
......@@ -352,9 +355,9 @@ static void do_field_decimal(Copy_field *copy)
}
/*
/**
string copy for single byte characters set when to string is shorter than
from string
from string.
*/
static void do_cut_string(Copy_field *copy)
......@@ -374,9 +377,9 @@ static void do_cut_string(Copy_field *copy)
}
/*
/**
string copy for multi byte characters set when to string is shorter than
from string
from string.
*/
static void do_cut_string_complex(Copy_field *copy)
......@@ -507,7 +510,7 @@ static void do_varstring2_mb(Copy_field *copy)
** The different functions that fills in a Copy_field class
***************************************************************************/
/*
/**
copy of field to maybe null string.
If field is null then the all bytes are set to 0.
if field is not null then the first byte is set to 1 and the rest of the
......@@ -748,7 +751,7 @@ Copy_field::get_copy_func(Field *to,Field *from)
}
/* Simple quick field convert that is called on insert */
/** Simple quick field convert that is called on insert. */
int field_conv(Field *to,Field *from)
{
......
This diff is collapsed.
......@@ -13,8 +13,11 @@
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */
/*
/**
@file
@details
@verbatim
The idea of presented algorithm see in
"The Art of Computer Programming" by Donald E. Knuth
Volume 3 "Sorting and searching"
......@@ -63,11 +66,13 @@ for optimization, link is the 16-bit index in 'symbols' or 'sql_functions'
or search-array..
So, we can read full search-structure as 32-bit word
@endverbatim
TODO:
1. use instead to_upper_lex, special array
@todo
use instead to_upper_lex, special array
(substitute chars) without skip codes..
2. try use reverse order of comparing..
@todo
try use reverse order of comparing..
*/
......
This diff is collapsed.
This diff is collapsed.
......@@ -14,8 +14,13 @@
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */
/*
Get hostname for an IP. Hostnames are checked with reverse name lookup and
/**
@file
@brief
Get hostname for an IP.
Hostnames are checked with reverse name lookup and
checked that they doesn't resemble an ip.
*/
......
......@@ -14,7 +14,12 @@
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */
/* Init and dummy functions for interface with unireg */
/**
@file
@brief
Init and dummy functions for interface with unireg
*/
#include "mysql_priv.h"
#include <m_ctype.h>
......
This diff is collapsed.
......@@ -14,12 +14,17 @@
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */
/* Buffers to save and compare item values */
/**
@file
@brief
Buffers to save and compare item values
*/
#include "mysql_priv.h"
/*
** Create right type of Cached_item for an item
/**
Create right type of Cached_item for an item.
*/
Cached_item *new_Cached_item(THD *thd, Item *item)
......@@ -45,9 +50,11 @@ Cached_item *new_Cached_item(THD *thd, Item *item)
Cached_item::~Cached_item() {}
/*
** Compare with old value and replace value with new value
** Return true if values have changed
/**
Compare with old value and replace value with new value.
@return
Return true if values have changed
*/
Cached_item_str::Cached_item_str(THD *thd, Item *arg)
......
This diff is collapsed.
......@@ -13,7 +13,12 @@
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */
/* Functions to create an item. Used by sql_yacc.yy */
/**
@file
@brief
Functions to create an item. Used by sql_yac.yy
*/
#include "mysql_priv.h"
#include "item_create.h"
......
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment