From 39062b7e4ee782ca7853808a1c006846ae027263 Mon Sep 17 00:00:00 2001 From: unknown Date: Tue, 9 Oct 2007 17:56:32 -0400 Subject: Doxygenize comments, a*.cc - field.cc . sql/derror.cc: Doxygenize comments. sql/des_key_file.cc: Doxygenize comments. sql/discover.cc: Doxygenize comments. sql/field.cc: Doxygenize comments. --- sql/discover.cc | 54 ++++++++++++++++++++++++++++-------------------------- 1 file changed, 28 insertions(+), 26 deletions(-) (limited to 'sql/discover.cc') diff --git a/sql/discover.cc b/sql/discover.cc index a7af90c440f..56dc00cc5c4 100644 --- a/sql/discover.cc +++ b/sql/discover.cc @@ -14,29 +14,33 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ -/* Functions for discover of frm file from handler */ +/** + @file + + @brief + Functions for discover of frm file from handler +*/ #include "mysql_priv.h" #include -/* - Read the contents of a .frm file +/** + Read the contents of a .frm file. - SYNOPSIS - readfrm() + frmdata and len are set to 0 on error. - name path to table-file "db/name" - frmdata frm data - len length of the read frmdata + @param name path to table-file "db/name" + @param frmdata frm data + @param len length of the read frmdata - RETURN VALUES - 0 ok - 1 Could not open file - 2 Could not stat file - 3 Could not allocate data for read - Could not read file - - frmdata and len are set to 0 on error + @retval + 0 ok + @retval + 1 Could not open file + @retval + 2 Could not stat file + @retval + 3 Could not allocate data for read. Could not read file */ int readfrm(const char *name, uchar **frmdata, size_t *len) @@ -87,18 +91,16 @@ int readfrm(const char *name, uchar **frmdata, size_t *len) /* Write the content of a frm data pointer - to a frm file - - SYNOPSIS - writefrm() + to a frm file. - name path to table-file "db/name" - frmdata frm data - len length of the frmdata + @param name path to table-file "db/name" + @param frmdata frm data + @param len length of the frmdata - RETURN VALUES - 0 ok - 2 Could not write file + @retval + 0 ok + @retval + 2 Could not write file */ int writefrm(const char *name, const uchar *frmdata, size_t len) -- cgit v1.2.1