Add Doxygen headers for common files

common/common.h

@@ -1,11 +1,10 @@
-/*
- ******************************************************************************
+/**
+ * \file common/common.h
  *
- * File:    common.h
- *
- * Purpose: Common header file for fwknop client and server programs.
- *
- *  Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
+ * \brief Common header file for fwknop client and server programs.
+ */
+
+/*  Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
  *  Copyright (C) 2009-2015 fwknop developers and contributors. For a full
  *  list of contributors, see the file 'CREDITS'.
  *

common/cunit_common.c

@@ -1,3 +1,9 @@
+/**
+ * \file common/cunit_common.c
+ *
+ * \brief CUnit test functions
+ */
+
 #ifdef HAVE_C_UNIT_TESTS
 
 #include "cunit_common.h"

common/cunit_common.h

@@ -1,3 +1,9 @@
+/**
+ * \file common/cunit_common.h
+ *
+ * \brief header file for CUnit tests
+ */
+
 #ifndef CUNIT_COMMON_H
 #define CUNIT_COMMON_H
 

common/fko_util.c

@@ -1,11 +1,10 @@
-/*
- *****************************************************************************
+/**
+ * \file common/fko_util.c
  *
- * File:    fko_util.c
- *
- * Purpose: Provide a set of common utility functions that fwknop can use.
- *
- *  Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
+ * \brief Provide a set of common utility functions that fwknop can use.
+ */
+
+/*  Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
  *  Copyright (C) 2009-2015 fwknop developers and contributors. For a full
  *  list of contributors, see the file 'CREDITS'.
  *

common/fko_util.h

@@ -1,11 +1,10 @@
-/*
- *****************************************************************************
+/**
+ * \file common/fko_util.h
  *
- * File:    fko_util.h
- *
- * Purpose: Header for utility functions used by libfko
- *
- *  Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
+ * \brief Header for utility functions used by libfko
+ */
+
+/*  Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
  *  Copyright (C) 2009-2015 fwknop developers and contributors. For a full
  *  list of contributors, see the file 'CREDITS'.
  *

common/netinet_common.h

@@ -1,13 +1,12 @@
-/*
- *****************************************************************************
+/**
+ * \file common/netinet_common.h
  *
- * File:    netinet_common.h
- *
- * Purpose: Header file for common network packet structures.  We roll our
+ * \brief Header file for common network packet structures.  We roll our
  *          own (actually copy) here in an effort to reduce the cross-
- *          platform "hoop-jumping" we would need to do). 
- *
- *  Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
+ *          platform "hoop-jumping" we would need to do.
+ */
+
+/*  Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
  *  Copyright (C) 2009-2015 fwknop developers and contributors. For a full
  *  list of contributors, see the file 'CREDITS'.
  *

common/strlcat.c

@@ -1,11 +1,10 @@
-/*
- *****************************************************************************
+/**
+ * \file common/strlcat.c
  *
- * File:    strlcat.c
- *
- * Purpose: Safer string concat routine.
- *
- * Copyright (c) 1998 Todd C. Miller <Todd.Miller@courtesan.com>
+ * \brief Safer string concat routine.
+ */
+
+/* Copyright (c) 1998 Todd C. Miller <Todd.Miller@courtesan.com>
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without

common/strlcpy.c

@@ -1,11 +1,10 @@
-/*
- *****************************************************************************
+/**
+ * \file common/strlcpy.c
  *
- * File:    strlcpy.c
- *
- * Purpose: Safer string copy routine.
- *
- * Copyright (c) 1998 Todd C. Miller <Todd.Miller@courtesan.com>
+ * \brief Safer string copy routine.
+ */
+
+/* Copyright (c) 1998 Todd C. Miller <Todd.Miller@courtesan.com>
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without