Doxygenize comments, a*.cc - field.cc .

sql/derror.cc

@@ -14,7 +14,12 @@
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA */
 
 
-/* Read language depeneded messagefile */
+/**
+  @file
+
+  @brief
+  Read language depeneded messagefile
+*/
 
 #include "mysql_priv.h"
 #include "mysys_err.h"
@@ -23,20 +28,17 @@ static bool read_texts(const char *file_name,const char ***point,
 		       uint error_messages);
 static void init_myfunc_errs(void);
 
-/*
+/**
   Read messages from errorfile.
 
-  SYNOPSIS
-    init_errmessage()
+  This function can be called multiple times to reload the messages.
+  If it fails to load the messages, it will fail softly by initializing
+  the errmesg pointer to an array of empty strings or by keeping the
+  old array if it exists.
 
-  DESCRIPTION
-    This function can be called multiple times to reload the messages.
-	If it fails to load the messages, it will fail softly by initializing
-	the errmesg pointer to an array of empty strings or by keeping the
-	old array if it exists.
-
-  RETURN
+  @retval
     FALSE       OK
+  @retval
     TRUE        Error
 */
 
@@ -75,7 +77,14 @@ bool init_errmessage(void)
 }
 
 
-	/* Read text from packed textfile in language-directory */
+/**
+  Read text from packed textfile in language-directory.
+
+  If we can't read messagefile then it's panic- we can't continue.
+
+  @todo
+    Convert the character set to server system character set
+*/
 
 static bool read_texts(const char *file_name,const char ***point,
 		       uint error_messages)
@@ -178,7 +187,9 @@ err1:
 } /* read_texts */
 
 
-	/* Initiates error-messages used by my_func-library */
+/**
+  Initiates error-messages used by my_func-library.
+*/
 
 static void init_myfunc_errs()
 {

sql/des_key_file.cc

@@ -21,17 +21,18 @@
 struct st_des_keyschedule des_keyschedule[10];
 uint   des_default_key;
 
-/*
- Function which loads DES keys from plaintext file into memory on MySQL
- server startup and on command FLUSH DES_KEY_FILE.
- Blame tonu@spam.ee on bugs ;)
-
- RETURN
-	0	ok
-	1	Error   
+#define des_cs	&my_charset_latin1
+
+/**
+  Load DES keys from plaintext file into
+  memory on MySQL server startup and on command FLUSH DES_KEY_FILE.
+
+  @retval
+    0  ok
+  @retval
+    1  Error   
 */
 
-#define des_cs	&my_charset_latin1
 
 bool
 load_des_key_file(const char *file_name)

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 <my_dir.h>
 
-/*
-  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)