[Ptpd-commit] SF.net SVN: ptpd:[63] trunk/src

[<gn...@us...>]

Revision: 63
          http://ptpd.svn.sourceforge.net/ptpd/?rev=63&view=rev
Author:   gnn
Date:     2010-07-20 21:59:54 +0000 (Tue, 20 Jul 2010)

Log Message:
-----------
Add proper file headers and comments.

Modified Paths:
--------------
    trunk/src/arith.c
    trunk/src/bmc.c
    trunk/src/constants.h
    trunk/src/datatypes.h
    trunk/src/dep/constants_dep.h
    trunk/src/dep/datatypes_dep.h
    trunk/src/dep/msg.c
    trunk/src/dep/net.c
    trunk/src/dep/ptpd_dep.h
    trunk/src/dep/servo.c
    trunk/src/dep/startup.c
    trunk/src/dep/sys.c
    trunk/src/dep/timer.c
    trunk/src/probe.c
    trunk/src/protocol.c
    trunk/src/ptpd.c
    trunk/src/ptpd.h

Modified: trunk/src/arith.c
===================================================================
--- trunk/src/arith.c	2010-07-13 15:25:37 UTC (rev 62)
+++ trunk/src/arith.c	2010-07-20 21:59:54 UTC (rev 63)
@@ -1,4 +1,11 @@
-/* arith.c */
+/**
+ * @file   arith.c
+ * @date   Tue Jul 20 16:12:51 2010
+ * 
+ * @brief  Time format conversion routines and additional math functions.
+ * 
+ * 
+ */
 
 #include "ptpd.h"
 

Modified: trunk/src/bmc.c
===================================================================
--- trunk/src/bmc.c	2010-07-13 15:25:37 UTC (rev 62)
+++ trunk/src/bmc.c	2010-07-20 21:59:54 UTC (rev 63)
@@ -1,4 +1,12 @@
-/* bmc.c */
+/**
+ * @file   bmc.c
+ * @date   Wed Jun 23 09:36:09 2010
+ * 
+ * @brief  Best master clock selection code.
+ * 
+ * The functions in this file are used by the daemon to select the
+ * best master clock from any number of possibilities.
+ */
 
 #include "ptpd.h"
 

Modified: trunk/src/constants.h
===================================================================
--- trunk/src/constants.h	2010-07-13 15:25:37 UTC (rev 62)
+++ trunk/src/constants.h	2010-07-20 21:59:54 UTC (rev 63)
@@ -1,4 +1,11 @@
-/* constants.h */
+/**
+ * @file   constants.h
+ * @date   Wed Jun 23 10:02:39 2010
+ * 
+ * @brief  All of the defined constants for the daemon.
+ * 
+ * 
+ */
 
 #ifndef CONSTANTS_H
 #define CONSTANTS_H

Modified: trunk/src/datatypes.h
===================================================================
--- trunk/src/datatypes.h	2010-07-13 15:25:37 UTC (rev 62)
+++ trunk/src/datatypes.h	2010-07-20 21:59:54 UTC (rev 63)
@@ -1,5 +1,13 @@
-/* datatypes.h */
+/**
+ * @file   datatypes.h
+ * @date   Wed Jun 23 09:37:14 2010
+ * 
+ * @brief  All of the datatypes used by the daemon.
+ * 
+ * 
+ */
 
+
 #ifndef DATATYPES_H
 #define DATATYPES_H
 

Modified: trunk/src/dep/constants_dep.h
===================================================================
--- trunk/src/dep/constants_dep.h	2010-07-13 15:25:37 UTC (rev 62)
+++ trunk/src/dep/constants_dep.h	2010-07-20 21:59:54 UTC (rev 63)
@@ -1,10 +1,15 @@
-/* constants_dep.h */
+/**
+ * @file   constants_dep.h
+ * @date   Tue Jul 20 16:16:23 2010
+ * 
+ * @brief  Platform dependent constants
+ * 
+ * 
+ */
 
 #ifndef CONSTANTS_DEP_H
 #define CONSTANTS_DEP_H
 
-/* platform dependent */
-
 #include <limits.h>
 
 #if !defined(linux) && !defined(__NetBSD__) && !defined(__FreeBSD__)

Modified: trunk/src/dep/datatypes_dep.h
===================================================================
--- trunk/src/dep/datatypes_dep.h	2010-07-13 15:25:37 UTC (rev 62)
+++ trunk/src/dep/datatypes_dep.h	2010-07-20 21:59:54 UTC (rev 63)
@@ -1,4 +1,11 @@
-/* datatypes_dep.h */
+/**
+ * @file   datatypes_dep.h
+ * @date   Tue Jul 20 16:16:48 2010
+ * 
+ * @brief  Platform dependent datatypes.
+ * 
+ * 
+ */
 
 #ifndef DATATYPES_DEP_H
 #define DATATYPES_DEP_H

Modified: trunk/src/dep/msg.c
===================================================================
--- trunk/src/dep/msg.c	2010-07-13 15:25:37 UTC (rev 62)
+++ trunk/src/dep/msg.c	2010-07-20 21:59:54 UTC (rev 63)
@@ -1,6 +1,14 @@
-/* msg.c */
-/* see spec annex d */
+/**
+ * @file   msg.c
+ * @author George Neville-Neil <gn...@ne...>
+ * @date   Tue Jul 20 16:17:05 2010
+ * 
+ * @brief  Functions to pack and unpack messages.
+ * 
+ * See spec annex d
+ */
 
+
 #include "../ptpd.h"
 
 Boolean 

Modified: trunk/src/dep/net.c
===================================================================
--- trunk/src/dep/net.c	2010-07-13 15:25:37 UTC (rev 62)
+++ trunk/src/dep/net.c	2010-07-20 21:59:54 UTC (rev 63)
@@ -1,4 +1,11 @@
-/* net.c */
+/**
+ * @file   net.c
+ * @date   Tue Jul 20 16:17:49 2010
+ * 
+ * @brief  Functions to interact with the network sockets and NIC driver.
+ * 
+ * 
+ */
 
 #include "../ptpd.h"
 

Modified: trunk/src/dep/ptpd_dep.h
===================================================================
--- trunk/src/dep/ptpd_dep.h	2010-07-13 15:25:37 UTC (rev 62)
+++ trunk/src/dep/ptpd_dep.h	2010-07-20 21:59:54 UTC (rev 63)
@@ -1,4 +1,11 @@
-/* ptpd_dep.h */
+/**
+ * @file   ptpd_dep.h
+ * @date   Tue Jul 20 16:18:39 2010
+ * 
+ * @brief  External definitions for inclusion elsewhere.
+ * 
+ * 
+ */
 
 #ifndef PTPD_DEP_H
 #define PTPD_DEP_H

Modified: trunk/src/dep/servo.c
===================================================================
--- trunk/src/dep/servo.c	2010-07-13 15:25:37 UTC (rev 62)
+++ trunk/src/dep/servo.c	2010-07-20 21:59:54 UTC (rev 63)
@@ -1,3 +1,12 @@
+/**
+ * @file   servo.c
+ * @date   Tue Jul 20 16:19:19 2010
+ * 
+ * @brief  Code which implements the clock servo in software.
+ * 
+ * 
+ */
+
 #include "../ptpd.h"
 
 void 

Modified: trunk/src/dep/startup.c
===================================================================
--- trunk/src/dep/startup.c	2010-07-13 15:25:37 UTC (rev 62)
+++ trunk/src/dep/startup.c	2010-07-20 21:59:54 UTC (rev 63)
@@ -1,4 +1,12 @@
-/* startup.c */
+/**
+ * @file   startup.c
+ * @date   Wed Jun 23 09:33:27 2010
+ * 
+ * @brief  Code to handle daemon startup, including command line args
+ * 
+ * The function in this file are called when the daemon starts up
+ * and include the getopt() command line argument parsing.
+ */
 
 #include "../ptpd.h"
 

Modified: trunk/src/dep/sys.c
===================================================================
--- trunk/src/dep/sys.c	2010-07-13 15:25:37 UTC (rev 62)
+++ trunk/src/dep/sys.c	2010-07-20 21:59:54 UTC (rev 63)
@@ -1,4 +1,11 @@
-/* sys.c */
+/**
+ * @file   sys.c
+ * @date   Tue Jul 20 16:19:46 2010
+ * 
+ * @brief  Code to call kernel time routines and also display server statistics.
+ * 
+ * 
+ */
 
 #include "../ptpd.h"
 

Modified: trunk/src/dep/timer.c
===================================================================
--- trunk/src/dep/timer.c	2010-07-13 15:25:37 UTC (rev 62)
+++ trunk/src/dep/timer.c	2010-07-20 21:59:54 UTC (rev 63)
@@ -1,4 +1,11 @@
-/* timer.c */
+/**
+ * @file   timer.c
+ * @date   Wed Jun 23 09:41:26 2010
+ * 
+ * @brief  The timers which run the state machine.
+ * 
+ * Timers in the PTP daemon are run off of the signal system.  
+ */
 
 #include "../ptpd.h"
 

Modified: trunk/src/probe.c
===================================================================
--- trunk/src/probe.c	2010-07-13 15:25:37 UTC (rev 62)
+++ trunk/src/probe.c	2010-07-20 21:59:54 UTC (rev 63)
@@ -1,3 +1,12 @@
+/**
+ * @file   probe.c
+ * @date   Tue Jul 20 16:13:30 2010
+ * 
+ * @brief  Management packet handling
+ * 
+ * 
+ */
+
 #include "ptpd.h"
 
 #define KEY_ARRAY_LEN 6

Modified: trunk/src/protocol.c
===================================================================
--- trunk/src/protocol.c	2010-07-13 15:25:37 UTC (rev 62)
+++ trunk/src/protocol.c	2010-07-20 21:59:54 UTC (rev 63)
@@ -1,4 +1,11 @@
-/* protocol.c */
+/**
+ * @file   protocol.c
+ * @date   Wed Jun 23 09:40:39 2010
+ * 
+ * @brief  The code that handles the IEEE-1588 protocol and state machine
+ * 
+ * 
+ */
 
 #include "ptpd.h"
 

Modified: trunk/src/ptpd.c
===================================================================
--- trunk/src/ptpd.c	2010-07-13 15:25:37 UTC (rev 62)
+++ trunk/src/ptpd.c	2010-07-20 21:59:54 UTC (rev 63)
@@ -1,4 +1,15 @@
-/* ptpd.c */
+/**
+ * @file   ptpd.c
+ * @date   Wed Jun 23 10:13:38 2010
+ * 
+ * @brief  The main() function for the PTP daemon
+ * 
+ * This file contains very little code, as should be obvious,
+ * and only serves to tie together the rest of the daemon.
+ * All of the default options are set here, but command line
+ * arguments are processed in the ptpdStartup() routine called
+ * below.
+ */
 
 #include "ptpd.h"
 

Modified: trunk/src/ptpd.h
===================================================================
--- trunk/src/ptpd.h	2010-07-13 15:25:37 UTC (rev 62)
+++ trunk/src/ptpd.h	2010-07-20 21:59:54 UTC (rev 63)
@@ -1,4 +1,11 @@
-/* ptpd.h */
+/**
+ * @file   ptpd.h
+ * @date   Tue Jul 20 16:15:04 2010
+ * 
+ * @brief  Bulk include file for the daemon, has all necessary local headers.
+ * 
+ * 
+ */
 
 #ifndef PTPD_H
 #define PTPD_H


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.