Add Doxygen headers for server files

Doxyfile

@@ -877,6 +877,7 @@ EXCLUDE_PATTERNS       = */perl/* \
                          */android/* \
                          */test/* \
                          */extras/* \
+                         */win32/* \
                          */python/*
 
 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names

server/access.c

@@ -1,11 +1,10 @@
-/*
- ******************************************************************************
+/**
+ * \file server/access.c
  *
- * File:    access.c
- *
- * Purpose: Access.conf file processing for fwknop server.
- *
- *  Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
+ * \brief Access.conf file processing for fwknop server.
+ */
+
+/*  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'.
  *

server/access.h

@@ -1,11 +1,10 @@
-/*
- ******************************************************************************
+/**
+ * \file server/access.h
  *
- * File:    access.h
- *
- * Purpose: Header file for fwknopd access.c.
- *
- *  Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
+ * \brief Header file for fwknopd access.c.
+ */
+
+/*  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'.
  *

server/cmd_cycle.c

@@ -1,10 +1,11 @@
-/*
- * @file    cmd_cycle.c
+/**
+ * \file server/cmd_cycle.c
  *
- * @brief   Fwknop routines for managing command cycles as defined via
+ * \brief Fwknop routines for managing command cycles as defined via
  *          access.conf stanzas (CMD_CYCLE_OPEN and CMD_CYCLE_CLOSE).
- *
- *  Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
+ */
+
+/*  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'.
  *

server/cmd_cycle.h

@@ -1,11 +1,11 @@
 /**
+ * \file server/cmd_cycle.h
  *
- * @file    cmd_cycle.h
- *
- * @brief: Function prototypes for managing command cycles as defined via
+ * \brief Function prototypes for managing command cycles as defined via
  *          access.conf stanzas (CMD_CYCLE_OPEN and CMD_CYCLE_CLOSE).
- *
- *  Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
+ */
+
+/*  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'.
  *

server/cmd_opts.h

@@ -1,11 +1,10 @@
-/*
- ******************************************************************************
+/**
+ * \file server/cmd_opts.h
  *
- * File:    cmd_opts.h
- *
- * Purpose: Header file for fwknopd command line options.
- *
- *  Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
+ * \brief Header file for fwknopd command line options.
+ */
+
+/*  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'.
  *

server/config_init.c

@@ -1,11 +1,10 @@
-/*
- ******************************************************************************
+/**
+ * \file server/config_init.c
  *
- * File:    config_init.c
- *
- * Purpose: Command-line and config file processing for fwknop server.
- *
- *  Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
+ * \brief Command-line and config file processing for fwknop server.
+ */
+
+/*  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'.
  *

server/config_init.h

@@ -1,11 +1,10 @@
-/*
- ******************************************************************************
+/**
+ * \file server/config_init.h
  *
- * File:    config_init.h
- *
- * Purpose: Header file for fwknopd config_init.
- *
- *  Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
+ * \brief Header file for fwknopd config_init.
+ */
+
+/*  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'.
  *

server/extcmd.c

@@ -1,11 +1,10 @@
-/*
- *****************************************************************************
+/**
+ * \file server/extcmd.c
  *
- * File:    extcmd.c
- *
- * Purpose: Routines for executing and processing external commands.
- *
- *  Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
+ * \brief Routines for executing and processing external commands.
+ */
+
+/*  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'.
  *

server/extcmd.h

@@ -1,11 +1,10 @@
-/*
- *****************************************************************************
+/**
+ * \file server/extcmd.h
  *
- * File:    extcmd.h
- *
- * Purpose: Header file for extcmd.c.
- *
- *  Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
+ * \brief Header file for extcmd.c.
+ */
+
+/*  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'.
  *

server/fw_util.c

@@ -1,11 +1,10 @@
-/*
- *****************************************************************************
+/**
+ * \file server/fw_util.c
  *
- * File:    fw_util.c
- *
- * Purpose: Fwknop routines for managing the firewall rules.
- *
- *  Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
+ * \brief Fwknop routines for managing the firewall rules.
+ */
+
+/*  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'.
  *

server/fw_util.h

@@ -1,11 +1,10 @@
-/*
- *****************************************************************************
+/**
+ * \file server/fw_util.h
  *
- * File:    fw_util.h
- *
- * Purpose: Header file for fw_util.c.
- *
- *  Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
+ * \brief Header file for fw_util.c.
+ */
+
+/*  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'.
  *

server/fw_util_firewalld.c

@@ -1,11 +1,10 @@
-/*
- *****************************************************************************
+/**
+ * \file server/fw_util_firewalld.c
  *
- * File:    fw_util_firewalld.c
- *
- * Purpose: Fwknop routines for managing firewalld firewall rules.
- *
- *  Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
+ * \brief Fwknop routines for managing firewalld firewall rules.
+ */
+
+/*  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'.
  *

server/fw_util_firewalld.h

@@ -1,11 +1,10 @@
-/*
- *****************************************************************************
+/**
+ * \file server/fw_util_firewalld.h
  *
- * File:    fw_util_firewalld.h
- *
- * Purpose: Header file for fw_util_firewalld.c.
- *
- *  Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
+ * \brief Header file for fw_util_firewalld.c.
+ */
+
+/*  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'.
  *

server/fw_util_ipf.c

@@ -1,11 +1,10 @@
-/*
- *****************************************************************************
+/**
+ * \file server/fw_util_ipf.c
  *
- * File:    fw_util_ipf.c
- *
- * Purpose: Fwknop routines for managing ipf firewall rules.
- *
- *  Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
+ * \brief Fwknop routines for managing ipf firewall rules.
+ */
+
+/*  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'.
  *

server/fw_util_ipf.h

@@ -1,11 +1,10 @@
-/*
- *****************************************************************************
+/**
+ * \file server/fw_util_ipf.h
  *
- * File:    fw_util_ipf.h
- *
- * Purpose: Header file for fw_util_ipf.c.
- *
- *  Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
+ * \brief Header file for fw_util_ipf.c.
+ */
+
+/*  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'.
  *

server/fw_util_ipfw.c

@@ -1,11 +1,10 @@
-/*
- *****************************************************************************
+/**
+ * \file server/fw_util_ipfw.c
  *
- * File:    fw_util_ipfw.c
- *
- * Purpose: Fwknop routines for managing ipfw firewall rules.
- *
- *  Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
+ * \brief Fwknop routines for managing ipfw firewall rules.
+ */
+
+/*  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'.
  *

server/fw_util_ipfw.h

@@ -1,11 +1,10 @@
-/*
- *****************************************************************************
+/**
+ * \file server/fw_util_ipfw.h
  *
- * File:    fw_util_ipfw.h
- *
- * Purpose: Header file for fw_util_ipfw.c.
- *
- *  Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
+ * \brief Header file for fw_util_ipfw.c.
+ */
+
+/*  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'.
  *

server/fw_util_iptables.c

@@ -1,11 +1,10 @@
-/*
- *****************************************************************************
+/**
+ * \file server/fw_util_iptables.c
  *
- * File:    fw_util_iptables.c
- *
- * Purpose: Fwknop routines for managing iptables firewall rules.
- *
- *  Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
+ * \brief Fwknop routines for managing iptables firewall rules.
+ */
+
+/*  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'.
  *

server/fw_util_iptables.h

@@ -1,11 +1,10 @@
-/*
- *****************************************************************************
+/**
+ * \file server/fw_util_iptables.h
  *
- * File:    fw_util_iptables.h
- *
- * Purpose: Header file for fw_util_iptables.c.
- *
- *  Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
+ * \brief Header file for fw_util_iptables.c.
+ */
+
+/*  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'.
  *

server/fw_util_pf.c

@@ -1,11 +1,10 @@
-/*
- *****************************************************************************
+/**
+ * \file server/fw_util_pf.c
  *
- * File:    fw_util_pf.c
- *
- * Purpose: Fwknop routines for managing pf firewall rules.
- *
- *  Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
+ * \brief Fwknop routines for managing pf firewall rules.
+ */
+
+/*  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'.
  *

server/fw_util_pf.h

@@ -1,11 +1,10 @@
-/*
- *****************************************************************************
+/**
+ * \file server/fw_util_pf.h
  *
- * File:    fw_util_pf.h
- *
- * Purpose: Header file for fw_util_pf.c.
- *
- *  Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
+ * \brief Header file for fw_util_pf.c.
+ */
+
+/*  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'.
  *

server/fwknopd.c

@@ -1,9 +1,7 @@
-/*
- *****************************************************************************
+/**
+ * \file server/fwknopd.c
  *
- * File:    fwknopd.c
- *
- * Purpose: An implementation of an fwknop server.
+ * \brief An implementation of an fwknop server.
  *
  *  Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
  *  Copyright (C) 2009-2015 fwknop developers and contributors. For a full

server/fwknopd.h

@@ -1,11 +1,10 @@
-/*
- *****************************************************************************
+/**
+ * \file server/fwknopd.h
  *
- * File:    fwknopd.h
- *
- * Purpose: Header file for fwknopd server program.
- *
- *  Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
+ * \brief Header file for fwknopd server program.
+ */
+
+/*  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'.
  *

server/fwknopd_common.h

@@ -1,11 +1,10 @@
-/*
- ******************************************************************************
+/**
+ * \file server/fwknopd_common.h
  *
- * File:    fwknopd_common.h
- *
- * Purpose: Header file for fwknopd source files.
- *
- *  Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
+ * \brief Header file for fwknopd source files.
+ */
+
+/*  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'.
  *

server/fwknopd_errors.c

@@ -1,11 +1,10 @@
-/*
- *****************************************************************************
+/**
+ * \file server/fwknopd_errors.c
  *
- * File:    errors.c
- *
- * Purpose: Error message functions for fwknopd
- *
- *  Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
+ * \brief Error message functions for fwknopd
+ */
+
+/*  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'.
  *

server/fwknopd_errors.h

@@ -1,11 +1,10 @@
-/*
- *****************************************************************************
+/**
+ * \file server/fwknopd_errors.h
  *
- * File:    fwknopd_errors.h
- *
- * Purpose: Header file for fwknopd_errors.c.
- *
- *  Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
+ * \brief Header file for fwknopd_errors.c.
+ */
+
+/*  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'.
  *

server/fwknopd_utests.c

@@ -1,3 +1,9 @@
+/**
+ * \file server/fwknopd_utests.c
+ *
+ * \brief CUnit tests for the server
+ */
+
 #include "CUnit/Basic.h"
 
 #include "fwknopd_common.h"
@@ -5,7 +11,7 @@
 
 /**
  * Register test suites from FKO files.
- * 
+ *
  * The module should fetch functions according to used modules. All of them follow the same
  * naming convention.
  */

server/incoming_spa.c

@@ -1,11 +1,10 @@
-/*
- *****************************************************************************
+/**
+ * \file server/incoming_spa.c
  *
- * File:    incoming_spa.c
- *
- * Purpose: Process an incoming SPA data packet for fwknopd.
- *
- *  Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
+ * \brief Process an incoming SPA data packet for fwknopd.
+ */
+
+/*  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'.
  *

server/incoming_spa.h

@@ -1,11 +1,10 @@
-/*
- *****************************************************************************
+/**
+ * \file server/incoming_spa.h
  *
- * File:    incoming_spa.h
- *
- * Purpose: Header file for incoming_spa.c.
- *
- *  Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
+ * \brief Header file for incoming_spa.c.
+ */
+
+/*  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'.
  *

server/log_msg.c

@@ -1,12 +1,11 @@
-/*
- *****************************************************************************
+/**
+ * \file server/log_msg.c
  *
- * File:    log_msg.c
- *
- * Purpose: General logging routine that can write to syslog and/or stderr
+ * \brief General logging routine that can write to syslog and/or stderr
  *          and can take varibale number of args.
- *
- *  Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
+ */
+
+/*  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'.
  *

server/log_msg.h

@@ -1,11 +1,10 @@
-/*
- *****************************************************************************
+/**
+ * \file server/log_msg.h
  *
- * File:    log_msg.h
- *
- * Purpose: Header file for log_msg.c.
- *
- *  Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
+ * \brief Header file for log_msg.c.
+ */
+
+/*  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'.
  *

server/pcap_capture.c

@@ -1,11 +1,10 @@
-/*
- *****************************************************************************
+/**
+ * \file server/pcap_capture.c
  *
- * File:    pcap_capture.c
- *
- * Purpose: The pcap capture routines for fwknopd.
- *
- *  Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
+ * \brief The pcap capture routines for fwknopd.
+ */
+
+/*  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'.
  *

server/pcap_capture.h

@@ -1,11 +1,10 @@
-/*
- *****************************************************************************
+/**
+ * \file server/pcap_capture.h
  *
- * File:    pcap_capture.h
- *
- * Purpose: Header file for pcap_capture.c.
- *
- *  Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
+ * \brief Header file for pcap_capture.c.
+ */
+
+/*  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'.
  *

server/process_packet.c

@@ -1,14 +1,15 @@
-/*
- *****************************************************************************
+/**
+ * \file server/process_packet.c
  *
- * File:    process_packet.c
+ * \brief Packet parser/decoder for fwknopd server.
  *
- * Purpose: Packet parser/decoder for fwknopd server.  Takes the raw packet
+ *          Takes the raw packet
  *          data from libpcap and parses/extracts the packet data payload,
  *          then creates an FKO context with that data.  If the context
  *          creation is successful, it is queued for processing.
- *
- *  Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
+ */
+
+/*  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'.
  *

server/process_packet.h

@@ -1,11 +1,10 @@
-/*
- *****************************************************************************
+/**
+ * \file server/process_packet.h
  *
- * File:    process_packet.h
- *
- * Purpose: Header file for process_packet and other fwknopd code.
- *
- *  Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
+ * \brief Header file for process_packet and other fwknopd code.
+ */
+
+/*  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'.
  *

server/replay_cache.c

@@ -1,15 +1,16 @@
-/*
- *****************************************************************************
+/**
+ * \file server/replay_cache.c
  *
- * File:    replay_cache.c
+ * \brief Cache packets for replay attack detection
  *
- * Purpose: Provides the functions to check for possible replay attacks
+ *          Provides the functions to check for possible replay attacks
  *          by using a cache of previously seen digests.  This cache is a
  *          simple file by default, but can be made to use a dbm solution
  *          (ndbm or gdbm in ndbm compatibility mode) file to store the digest
  *          of a previously received SPA packets.
- *
- *  Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
+ */
+
+/*  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'.
  *

server/replay_cache.h

@@ -1,11 +1,10 @@
-/*
- *****************************************************************************
+/**
+ * \file server/replay_cache.h
  *
- * File:    replay_cache.h
- *
- * Purpose: Header file for fwknopd replay_cache.c functions.
- *
- *  Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
+ * \brief Header file for fwknopd replay_cache.c functions.
+ */
+
+/*  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'.
  *

server/sig_handler.c

@@ -1,11 +1,10 @@
-/*
- *****************************************************************************
+/**
+ * \file server/sig_handler.c
  *
- * File:    sig_handler.c
- *
- * Purpose: Signal handling dta and routines for fwknopd.
- *
- *  Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
+ * \brief Signal handling dta and routines for fwknopd.
+ */
+
+/*  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'.
  *

server/sig_handler.h

@@ -1,11 +1,10 @@
-/*
- *****************************************************************************
+/**
+ * \file server/sig_handler.h
  *
- * File:    sig_handler.h
- *
- * Purpose: Header file for sig_handler functions and data.
- *
- *  Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
+ * \brief Header file for sig_handler functions and data.
+ */
+
+/*  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'.
  *

server/tcp_server.c

@@ -1,12 +1,11 @@
-/*
- *****************************************************************************
+/**
+ * \file server/tcp_server.c
  *
- * File:    tcp_server.c
- *
- * Purpose: Spawns off a dummy tcp server for fwknopd.  Its purpose is
+ * \brief Spawns off a dummy tcp server for fwknopd.  Its purpose is
  *          to accept a tcp connection, then drop it after the first packet.
- *
- *  Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
+ */
+
+/*  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'.
  *

server/tcp_server.h

@@ -1,11 +1,10 @@
-/*
- *****************************************************************************
+/**
+ * \file server/tcp_server.h
  *
- * File:    tcp_server.h
- *
- * Purpose: Header file for tcp_server.c.
- *
- *  Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
+ * \brief Header file for tcp_server.c.
+ */
+
+/*  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'.
  *

server/udp_server.c

@@ -1,11 +1,10 @@
-/*
- *****************************************************************************
+/**
+ * \file server/udp_server.c
  *
- * File:    udp_server.c
- *
- * Purpose: Collect SPA packets via a UDP server.
- *
- *  Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
+ * \brief Collect SPA packets via a UDP server.
+ */
+
+/*  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'.
  *

server/udp_server.h

@@ -1,11 +1,10 @@
-/*
- *****************************************************************************
+/**
+ * \file server/udp_server.h
  *
- * File:    udp_server.h
- *
- * Purpose: Header file for udp_server.c.
- *
- *  Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
+ * \brief Header file for udp_server.c.
+ */
+
+/*  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'.
  *

server/utils.c

@@ -1,9 +1,10 @@
 /**
- * @file    utils.c
+ * \file server/utils.c
  *
- * @brief   General/Generic functions for the fwknop server.
- *
- *  Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
+ * \brief General/Generic functions for the fwknop server.
+ */
+
+/*  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'.
  *

server/utils.h

@@ -1,11 +1,10 @@
-/*
- *****************************************************************************
+/**
+ * \file server/utils.h
  *
- * File:    utils.h
- *
- * Purpose: Header file for utils.c fwknopd server program.
- *
- *  Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
+ * \brief Header file for utils.c fwknopd server program.
+ */
+
+/*  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'.
  *