From e797b466b4234c5960927de0fde2077fe6293626 Mon Sep 17 00:00:00 2001
From: unknown <salle@geopard.(none)>
Date: Tue, 9 Jul 2002 18:59:52 +0300
Subject: Rewrite function comments

mysys/array.c:
  Rewrite functions comments
mysys/checksum.c:
  Rewrite function comment
  Style cleanup
mysys/mulalloc.c:
  Rewrite function comment
mysys/my_chsize.c:
  Rewrite function comment
mysys/my_error.c:
  Rewrite comments
mysys/my_once.c:
  Rewrite comments
mysys/my_div.c:
  Rewrite comments
mysys/my_open.c:
  Rewrite comments
---
 mysys/my_error.c | 32 ++++++++++++++++++++++++++++----
 1 file changed, 28 insertions(+), 4 deletions(-)

(limited to 'mysys/my_error.c')

diff --git a/mysys/my_error.c b/mysys/my_error.c
index 61f8c16aba5..5ce061212b5 100644
--- a/mysys/my_error.c
+++ b/mysys/my_error.c
@@ -25,8 +25,15 @@
 const char ** NEAR my_errmsg[MAXMAPS]={0,0,0,0};
 char NEAR errbuff[NRERRBUFFS][ERRMSGSIZE];
 
-/* Error message to user */
-/*VARARGS2*/
+/*
+   Error message to user
+
+   SYNOPSIS
+     my_error()
+       nr	Errno
+       MyFlags	Flags
+       ...	variable list
+*/
 
 int my_error(int nr,myf MyFlags, ...)
 {
@@ -102,7 +109,16 @@ int my_error(int nr,myf MyFlags, ...)
   DBUG_RETURN((*error_handler_hook)(nr, ebuff, MyFlags));
 }
 
-	/* Error as printf */
+/*
+  Error as printf
+
+  SYNOPSIS
+    my_printf_error()
+      error	Errno
+      format	Format string
+      MyFlags	Flags
+      ...	variable list
+*/
 
 int my_printf_error (uint error, const char *format, myf MyFlags, ...)
 {
@@ -115,7 +131,15 @@ int my_printf_error (uint error, const char *format, myf MyFlags, ...)
   return (*error_handler_hook)(error, ebuff, MyFlags);
 }
 
-	/* Give message using error_handler_hook */
+/*
+  Give message using error_handler_hook
+
+  SYNOPSIS
+    my_message()
+      error	Errno
+      str	Error message
+      MyFlags	Flags
+*/
 
 int my_message(uint error, const char *str, register myf MyFlags)
 {
-- 
cgit v1.2.1