From 53d0a1510ca97cd1ddfc6ffa5610ac83f4cd5079 Mon Sep 17 00:00:00 2001
From: tbrennan3 <tbrennan3@1e814d3a-8a88-4260-be86-c0dc25669c1e>
Date: Sun, 14 Feb 2010 05:46:31 +0000
Subject: [PATCH] The beginning of doxygenation, for the Linux port: As a first
 step, added an @file description for each file.

---
 bacnet-stack/ports/linux/arcnet.c   | 2 ++
 bacnet-stack/ports/linux/bip-init.c | 2 ++
 bacnet-stack/ports/linux/dlmstp.c   | 2 ++
 bacnet-stack/ports/linux/ethernet.c | 2 ++
 bacnet-stack/ports/linux/main.c     | 3 ++-
 bacnet-stack/ports/linux/mstpsnap.c | 2 ++
 bacnet-stack/ports/linux/net.h      | 2 ++
 bacnet-stack/ports/linux/rs485.c    | 2 ++
 bacnet-stack/ports/linux/rx_fsm.c   | 2 ++
 bacnet-stack/ports/linux/timer.c    | 2 ++
 bacnet-stack/ports/linux/timer.h    | 1 +
 11 files changed, 21 insertions(+), 1 deletion(-)

diff --git a/bacnet-stack/ports/linux/arcnet.c b/bacnet-stack/ports/linux/arcnet.c
index 24fe2d07..324dce31 100644
--- a/bacnet-stack/ports/linux/arcnet.c
+++ b/bacnet-stack/ports/linux/arcnet.c
@@ -38,6 +38,8 @@
 #include "arcnet.h"
 #include "net.h"
 
+/** @file linux/arcnet.c  Provides Linux-specific functions for Arcnet. */
+
 /* my local device data - MAC address */
 uint8_t ARCNET_MAC_Address = 0;
 /* ARCNET file handle */
diff --git a/bacnet-stack/ports/linux/bip-init.c b/bacnet-stack/ports/linux/bip-init.c
index e54b4947..8ccd2d5f 100644
--- a/bacnet-stack/ports/linux/bip-init.c
+++ b/bacnet-stack/ports/linux/bip-init.c
@@ -38,6 +38,8 @@
 #include "bip.h"
 #include "net.h"
 
+/** @file linux/bip-init.c  Initializes BACnet/IP interface (Linux). */
+
 bool BIP_Debug = false;
 
 /* gets an IP address by name, where name can be a
diff --git a/bacnet-stack/ports/linux/dlmstp.c b/bacnet-stack/ports/linux/dlmstp.c
index 367bc572..34a27ed1 100644
--- a/bacnet-stack/ports/linux/dlmstp.c
+++ b/bacnet-stack/ports/linux/dlmstp.c
@@ -38,6 +38,8 @@
 /* OS Specific include */
 #include "net.h"
 
+/** @file linux/dlmstp.c  Provides Linux-specific DataLink functions for MS/TP. */
+
 /* Number of MS/TP Packets Rx/Tx */
 uint16_t MSTP_Packets = 0;
 
diff --git a/bacnet-stack/ports/linux/ethernet.c b/bacnet-stack/ports/linux/ethernet.c
index e6711c1c..3caf3dd7 100644
--- a/bacnet-stack/ports/linux/ethernet.c
+++ b/bacnet-stack/ports/linux/ethernet.c
@@ -40,6 +40,8 @@
 #include "ethernet.h"
 #include "bacint.h"
 
+/** @file linux/ethernet.c  Provides Linux-specific functions for BACnet/Ethernet. */
+
 /* commonly used comparison address for ethernet */
 uint8_t Ethernet_Broadcast[MAX_MAC_LEN] =
     { 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF };
diff --git a/bacnet-stack/ports/linux/main.c b/bacnet-stack/ports/linux/main.c
index 090a89b1..fbec158e 100644
--- a/bacnet-stack/ports/linux/main.c
+++ b/bacnet-stack/ports/linux/main.c
@@ -45,7 +45,8 @@
 #include "txbuf.h"
 #include "dlenv.h"
 
-/* This is an example application using the BACnet Stack on Linux */
+/** @file linux/main.c  Example application using the BACnet Stack on Linux. */
+
 bool Who_Is_Request = true;
 
 /* buffers used for receiving */
diff --git a/bacnet-stack/ports/linux/mstpsnap.c b/bacnet-stack/ports/linux/mstpsnap.c
index 9adcf12a..8696e16f 100644
--- a/bacnet-stack/ports/linux/mstpsnap.c
+++ b/bacnet-stack/ports/linux/mstpsnap.c
@@ -48,6 +48,8 @@
 #include "mstptext.h"
 #include "bacint.h"
 
+/** @file linux/mstpsnap.c  Example application testing BACnet MS/TP on Linux. */
+
 #ifndef max
 #define max(a,b) (((a) (b)) ? (a) : (b))
 #define min(a,b) (((a) < (b)) ? (a) : (b))
diff --git a/bacnet-stack/ports/linux/net.h b/bacnet-stack/ports/linux/net.h
index 279081c6..e4cf610a 100644
--- a/bacnet-stack/ports/linux/net.h
+++ b/bacnet-stack/ports/linux/net.h
@@ -95,3 +95,5 @@
 #include <netdb.h>
 
 #endif
+
+/** @file linux/net.h  Includes Linux network headers. */
diff --git a/bacnet-stack/ports/linux/rs485.c b/bacnet-stack/ports/linux/rs485.c
index 242928ce..70b76d56 100644
--- a/bacnet-stack/ports/linux/rs485.c
+++ b/bacnet-stack/ports/linux/rs485.c
@@ -33,6 +33,8 @@
  -------------------------------------------
 ####COPYRIGHTEND####*/
 
+/** @file linux/rs485.c  Provides Linux-specific functions for RS-485 serial. */
+
 /* The module handles sending data out the RS-485 port */
 /* and handles receiving data from the RS-485 port. */
 /* Customize this file for your specific hardware */
diff --git a/bacnet-stack/ports/linux/rx_fsm.c b/bacnet-stack/ports/linux/rx_fsm.c
index 6923b9ce..d60a8545 100644
--- a/bacnet-stack/ports/linux/rx_fsm.c
+++ b/bacnet-stack/ports/linux/rx_fsm.c
@@ -54,6 +54,8 @@
 #include "mstp.h"
 #include "mstptext.h"
 
+/** @file linux/rx_fsm.c  Example app testing MS/TP Rx State Machine on Linux. */
+
 #ifndef max
 #define max(a,b) (((a) (b)) ? (a) : (b))
 #define min(a,b) (((a) < (b)) ? (a) : (b))
diff --git a/bacnet-stack/ports/linux/timer.c b/bacnet-stack/ports/linux/timer.c
index 4d512aa9..773ac941 100644
--- a/bacnet-stack/ports/linux/timer.c
+++ b/bacnet-stack/ports/linux/timer.c
@@ -28,6 +28,8 @@
 #include <time.h>
 #include "timer.h"
 
+/** @file linux/timer.c  Provides Linux-specific time and timer functions. */
+
 /* counter for the various timers */
 static volatile uint32_t Millisecond_Counter[MAX_MILLISECOND_TIMERS];
 
diff --git a/bacnet-stack/ports/linux/timer.h b/bacnet-stack/ports/linux/timer.h
index f08e0e1a..8cee552d 100644
--- a/bacnet-stack/ports/linux/timer.h
+++ b/bacnet-stack/ports/linux/timer.h
@@ -26,6 +26,7 @@
 
 #include <stdbool.h>
 #include <stdint.h>
+#include <sys/time.h>		// for timeval
 
 /* Timer Module */
 #ifndef MAX_MILLISECOND_TIMERS