Commit 013cec65 authored by thomas.forbriger's avatar thomas.forbriger Committed by thomas.forbriger
Browse files

documentation

This is a legacy commit from before 2015-03-01.
It may be incomplete as well as inconsistent.
See COPYING.legacy and README.history for details.


SVN Path:     http://gpitrsvn.gpi.uni-karlsruhe.de/repos/TFSoftware/trunk
SVN Revision: 2725
SVN UUID:     67feda4a-a26e-11df-9d6e-31afc202ad0c
parent 57244103
......@@ -3,7 +3,7 @@
*
* ----------------------------------------------------------------------------
*
* $Id: DL1direct.cc,v 1.6 2008-12-01 19:46:07 tforb Exp $
* $Id: DL1direct.cc,v 1.7 2008-12-22 11:54:26 tforb Exp $
* \author Thomas Forbriger
* \date 24/11/2008
*
......@@ -33,10 +33,16 @@
*
* ============================================================================
*/
/*! \page DL1direct The program DL1direct
*
* This program supports interactive control of the DL1 logger.
* You can use it to send commands and read data to standard output.
* Execute \code DL1direct -help\endcode to obtain a program description.
*/
#define DL1DIRECT_VERSION \
"DL1DIRECT V1.0 directly send command to DL1 and receive the response"
#define DL1DIRECT_CVSID \
"$Id: DL1direct.cc,v 1.6 2008-12-01 19:46:07 tforb Exp $"
"$Id: DL1direct.cc,v 1.7 2008-12-22 11:54:26 tforb Exp $"
#include <iostream>
#include <string>
......
......@@ -3,7 +3,7 @@
*
* ----------------------------------------------------------------------------
*
* $Id: DL1logger.cc,v 1.15 2008-12-19 21:52:33 tforb Exp $
* $Id: DL1logger.cc,v 1.16 2008-12-22 11:54:26 tforb Exp $
* \author Thomas Forbriger
* \date 27/11/2008
*
......@@ -34,10 +34,19 @@
*
* ============================================================================
*/
/*! \page DL1logger The program DL1logger
*
* This program runs in an infinite loop and controls data acquisition through
* the Thies DL1 data logger.
* It maintains the logger's internal clock and maintains a collection of data
* files.
* Execute \code DL1logger -help\endcode to obtain a description of the
* program's functionality.
*/
#define DL1LOGGER_VERSION \
"DL1LOGGER V1.0 data logging program for Thies DL1"
#define DL1LOGGER_CVSID \
"$Id: DL1logger.cc,v 1.15 2008-12-19 21:52:33 tforb Exp $"
"$Id: DL1logger.cc,v 1.16 2008-12-22 11:54:26 tforb Exp $"
// #define _GNU_SOURCE
#include <string.h>
......
......@@ -3,7 +3,7 @@
*
* ----------------------------------------------------------------------------
*
* $Id: thiesdl1.h,v 1.7 2008-12-03 17:29:27 tforb Exp $
* $Id: thiesdl1.h,v 1.8 2008-12-22 11:54:26 tforb Exp $
* \author Thomas Forbriger
* \date 25/11/2008
*
......@@ -40,7 +40,7 @@
#define DL_THIESDL1_H_VERSION \
"DL_THIESDL1_H V1.0 "
#define DL_THIESDL1_H_CVSID \
"$Id: thiesdl1.h,v 1.7 2008-12-03 17:29:27 tforb Exp $"
"$Id: thiesdl1.h,v 1.8 2008-12-22 11:54:26 tforb Exp $"
#include<iostream>
#include<serialxx/serialport.h>
......@@ -139,4 +139,13 @@ namespace dl1 {
#endif // DL_THIESDL1_H_VERSION (includeguard)
/*! \mainpage
*
* This is a collection of code that supports serial line access to the Thies
* DL1 precipitation data logger.
* Two programs are comin along with the code:
* - \ref DL1direct
* - \ref DL1logger
*/
/* ----- END OF thiesdl1.h ----- */
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment