Add Doxygen @file documentation to each source and header file

[ngircd-alex.git] / src / portab / strlcpy.c

diff --git a/src/portab/strlcpy.c b/src/portab/strlcpy.c
index 5e2c72228c1c6429d85f290abc0a4cd5e225f4c7..ae2018bcf940a3c47a1cc265740c58fbff70dce8 100644 (file)
--- a/src/portab/strlcpy.c
+++ b/src/portab/strlcpy.c
@@ -7,8 +7,14 @@
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version.
  * Please read the file COPYING, README and AUTHORS for more information.
- *
+ */
+
+#include "portab.h"
+
+/**
+ * @file
  * strlcpy() and strlcat() replacement functions.
+ *
  * See <http://www.openbsd.org/papers/strlcpy-paper.ps> for details.
  *
  * Code partially borrowed from compat.c of rsync, written by Andrew
@@ -16,11 +22,6 @@
  * <http://cvs.samba.org/cgi-bin/cvsweb/rsync/lib/compat.c>
  */
 
-
-#include "portab.h"
-
-static char UNUSED id[] = "$Id: strlcpy.c,v 1.4 2005/02/27 09:29:13 alex Exp $";
-
 #include "imp.h"
 #include <string.h>
 #include <sys/types.h>
@@ -31,7 +32,7 @@ static char UNUSED id[] = "$Id: strlcpy.c,v 1.4 2005/02/27 09:29:13 alex Exp $";
 #ifndef HAVE_STRLCAT
 
 GLOBAL size_t
-strlcat( CHAR *dst, CONST CHAR *src, size_t size )
+strlcat( char *dst, const char *src, size_t size )
 {
        /* Like strncat() but does not 0 fill the buffer and
         * always null terminates. */
@@ -55,7 +56,7 @@ strlcat( CHAR *dst, CONST CHAR *src, size_t size )
 #ifndef HAVE_STRLCPY
 
 GLOBAL size_t
-strlcpy( CHAR *dst, CONST CHAR *src, size_t size )
+strlcpy( char *dst, const char *src, size_t size )
 {
        /* Like strncpy but does not 0 fill the buffer and
         * always null terminates. */