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 ee93d1d6fcfba52a31b550d4e633edfd63ca3e42..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.
  * 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.
  * 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
  * 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>
  */
 
  * <http://cvs.samba.org/cgi-bin/cvsweb/rsync/lib/compat.c>
  */
 

-
-#include "portab.h"
-
-static char UNUSED id[] = "$Id: strlcpy.c,v 1.5 2005/03/19 18:43:50 fw Exp $";
-

 #include "imp.h"
 #include <string.h>
 #include <sys/types.h>
 #include "imp.h"
 #include <string.h>
 #include <sys/types.h>