documentation

git-svn-id: https://hamlib.svn.sourceforge.net/svnroot/hamlib/trunk@2151 7ae35d74-ebe9-4afe-98af-79ac388436b8

src/token.h

@@ -2,7 +2,7 @@
  *  Hamlib Interface - token header
  *  Copyright (c) 2000-2003 by Stephane Fillod
  *
- *	$Id: token.h,v 1.3 2003-05-03 13:17:25 fillods Exp $
+ *	$Id: token.h,v 1.4 2006-10-17 14:28:52 aa6e Exp $
  *
  *   This library is free software; you can redistribute it and/or modify
  *   it under the terms of the GNU Library General Public License as
@@ -20,34 +20,63 @@
  *
  */
 
+/**
+ * \addtogroup rig
+ * @{
+ */
+
+/**
+ * \brief Token definitions
+ * \file token.h
+ * 
+ */
+
 #ifndef _TOKEN_H
+
 #define _TOKEN_H 1
 
 #include <hamlib/rig.h>
 
+/** \brief Create a backend token, \a t */
 #define TOKEN_BACKEND(t) (t)
+/** \brief Create a frontend token, \a t */
 #define TOKEN_FRONTEND(t) ((t)|(1<<30))
+/** \brief Test for token - frontend? */
 #define IS_TOKEN_FRONTEND(t) ((t)&(1<<30))
 
+/** \brief Null frontend token */
 #define TOK_FRONTEND_NONE	TOKEN_FRONTEND(0)
+/** \brief Null backend token */
 #define TOK_BACKEND_NONE	TOKEN_BACKEND(0)
 
 /*
  * tokens shared among rig and rotator,
  * Numbers go from TOKEN_FRONTEND(1) to TOKEN_FRONTEND(99)
  */
-#define TOK_PATHNAME	TOKEN_FRONTEND(10)
-#define TOK_WRITE_DELAY	TOKEN_FRONTEND(12)
-#define TOK_POST_WRITE_DELAY	TOKEN_FRONTEND(13)
-#define TOK_TIMEOUT		TOKEN_FRONTEND(14)
-#define TOK_RETRY		TOKEN_FRONTEND(15)
 
+/** \brief Pathname is device for rig control, e.g. /dev/ttyS0 */
+#define TOK_PATHNAME	TOKEN_FRONTEND(10)
+/** \brief Delay before serial output (units?) */
+#define TOK_WRITE_DELAY	TOKEN_FRONTEND(12)
+/** \brief Delay after serial output (units?) */
+#define TOK_POST_WRITE_DELAY	TOKEN_FRONTEND(13)
+/** \brief Timeout delay (units?) */
+#define TOK_TIMEOUT		TOKEN_FRONTEND(14)
+/** \brief Number of retries permitted */
+#define TOK_RETRY		TOKEN_FRONTEND(15)
+/** \brief Serial speed - "baud rate" */
 #define TOK_SERIAL_SPEED	TOKEN_FRONTEND(20)
+/** \brief No. data bits per serial character */
 #define TOK_DATA_BITS	TOKEN_FRONTEND(21)
+/** \brief  No. stop bits per serial character */
 #define TOK_STOP_BITS	TOKEN_FRONTEND(22)
+/** \brief  Serial parity (format?) */
 #define TOK_PARITY		TOKEN_FRONTEND(23)
+/** \brief Serial Handshake (format?)  */
 #define TOK_HANDSHAKE	TOKEN_FRONTEND(24)
+/** \brief Serial Req. To Send status */
 #define TOK_RTS_STATE	TOKEN_FRONTEND(25)
+/** \brief  Serial Data Terminal Ready status */
 #define TOK_DTR_STATE	TOKEN_FRONTEND(26)
 
 /*
@@ -55,17 +84,26 @@
  */
 /* rx_range_list/tx_range_list, filters, announces, has(func,lvl,..) */
 
+/** \brief rig: ?? */
 #define TOK_VFO_COMP	TOKEN_FRONTEND(110)
+/** \brief rig: polling interval (units?) */
 #define TOK_POLL_INTERVAL	TOKEN_FRONTEND(111)
+/** \brief rig: International Telecommunications Union region no. */
 #define TOK_ITU_REGION	TOKEN_FRONTEND(120)
 
 /*
  * rotator specific tokens
  */
+/** \brief rot: Minimum Azimuth */
 #define TOK_MIN_AZ	TOKEN_FRONTEND(110)
+/** \brief rot: Maximum Azimuth */
 #define TOK_MAX_AZ	TOKEN_FRONTEND(111)
+/** \brief rot: Minimum Elevation */
 #define TOK_MIN_EL	TOKEN_FRONTEND(112)
+/** \brief rot: Maximum Elevation */
 #define TOK_MAX_EL	TOKEN_FRONTEND(113)
 
 
 #endif /* _TOKEN_H */
+
+/** @} */