2011-02-03 02:52:17 +00:00
|
|
|
/*! \mainpage Hamlib API Reference
|
2002-02-12 22:10:46 +00:00
|
|
|
|
2006-10-13 18:24:02 +00:00
|
|
|
\section auth Authors
|
2002-02-12 22:10:46 +00:00
|
|
|
|
2011-02-03 02:52:17 +00:00
|
|
|
Stéphane Fillod, F8CFE, and Frank Singleton, VK3FCS and the Hamlib Group
|
|
|
|
|
\n Documentation revisions by Martin Ewing, AA6E, Nate Bargmann, N0NB
|
2006-10-12 19:19:47 +00:00
|
|
|
|
2006-10-13 18:24:02 +00:00
|
|
|
\section s1 Preface
|
2004-08-09 20:55:31 +00:00
|
|
|
|
2011-02-03 02:52:17 +00:00
|
|
|
This document describes the Hamlib library Application Programming Interface
|
|
|
|
|
(API) for this distribution.
|
2002-02-12 22:10:46 +00:00
|
|
|
|
2011-02-03 02:52:17 +00:00
|
|
|
We attempt to document the complete API of the core modules of Hamlib, i.e.,
|
|
|
|
|
the API seen by end-user application developers. You may navigate the
|
|
|
|
|
documentation through the tabs at the top of this page.
|
2006-10-13 18:24:02 +00:00
|
|
|
|
2011-02-03 02:52:17 +00:00
|
|
|
Please report any problems to hamlib-developer@lists.sourceforge.net.
|
2006-10-13 18:24:02 +00:00
|
|
|
|
|
|
|
|
\section txtfil Distributed information files
|
|
|
|
|
|
|
|
|
|
These text files are distributed with the Hamlib package.
|
|
|
|
|
|
|
|
|
|
Readme files: \subpage Rdme "General";
|
|
|
|
|
\subpage Rdmebeta "Beta tester";
|
|
|
|
|
\subpage Rdmedevel "Developer";
|
|
|
|
|
\subpage Rdmewin32 "Win32"
|
|
|
|
|
|
|
|
|
|
Other files: \subpage INSTALL;
|
|
|
|
|
\subpage AUTHORS;
|
|
|
|
|
\subpage COPYING;
|
|
|
|
|
\subpage COPYING.LIB;
|
|
|
|
|
\subpage LICENSE;
|
|
|
|
|
\subpage NEWS;
|
|
|
|
|
\subpage PLAN;
|
|
|
|
|
\subpage THANKS;
|
|
|
|
|
\subpage TODO
|
|
|
|
|
|
|
|
|
|
\section lnks Internet links
|
|
|
|
|
|
2011-02-03 02:52:17 +00:00
|
|
|
\li http://www.hamlib.org -- project Wiki, including list of supported rigs.
|
|
|
|
|
\li http://sourceforge.net/projects/hamlib/ -- SourceForge.net project page.
|
|
|
|
|
\li http://hamlib.git.sourceforge.net/git/gitweb-index.cgi -- Git repository via Web
|
|
|
|
|
\li http://hamlib.svn.sourceforge.net/viewvc/hamlib/ -- SVN repository via Web
|
2006-10-13 18:24:02 +00:00
|
|
|
|
|
|
|
|
\section slic Documentation License
|
|
|
|
|
|
2006-10-17 01:26:44 +00:00
|
|
|
\li \subpage doclicense
|
|
|
|
|
*/
|
|
|
|
|
/*! \page doclicense License for Documentation
|
2006-10-13 18:24:02 +00:00
|
|
|
This documentation is free; you can redistribute it without
|
2002-02-12 22:10:46 +00:00
|
|
|
any restrictions. The modification or derived work must retain
|
2006-10-13 18:24:02 +00:00
|
|
|
copyright and list all authors.
|
2002-02-12 22:10:46 +00:00
|
|
|
|
2006-10-13 18:24:02 +00:00
|
|
|
This documentation is distributed in the hope that it will be
|
2002-02-12 22:10:46 +00:00
|
|
|
useful, but WITHOUT ANY WARRANTY; without even the implied warranty
|
2006-10-13 18:24:02 +00:00
|
|
|
of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
/*! \page Rdme README (general)
|
|
|
|
|
\verbinclude README
|
|
|
|
|
*/
|
|
|
|
|
/*! \page Rdmebeta README.betatester
|
|
|
|
|
\verbinclude README.betatester
|
|
|
|
|
*/
|
|
|
|
|
/*! \page Rdmedevel README.developer
|
|
|
|
|
\verbinclude README.developer
|
|
|
|
|
*/
|
|
|
|
|
/*! \page Rdmewin32 README.win32
|
|
|
|
|
\verbinclude README.win32
|
|
|
|
|
*/
|
|
|
|
|
/*! \page INSTALL INSTALL
|
|
|
|
|
\verbinclude INSTALL
|
|
|
|
|
*/
|
|
|
|
|
/*! \page AUTHORS AUTHORS
|
|
|
|
|
\verbinclude AUTHORS
|
|
|
|
|
*/
|
|
|
|
|
/*! \page COPYING COPYING
|
|
|
|
|
\verbinclude COPYING
|
|
|
|
|
*/
|
|
|
|
|
/*! \page COPYING.LIB COPYING.LIB
|
|
|
|
|
\verbinclude COPYING.LIB
|
|
|
|
|
*/
|
|
|
|
|
/*! \page LICENSE LICENSE
|
|
|
|
|
\verbinclude LICENSE
|
|
|
|
|
*/
|
|
|
|
|
/*! \page NEWS NEWS
|
|
|
|
|
\verbinclude NEWS
|
|
|
|
|
*/
|
|
|
|
|
/*! \page PLAN PLAN
|
|
|
|
|
\verbinclude PLAN
|
|
|
|
|
*/
|
|
|
|
|
/*! \page THANKS THANKS
|
|
|
|
|
\verbinclude THANKS
|
|
|
|
|
*/
|
|
|
|
|
/*! \page TODO TO DO
|
|
|
|
|
\verbinclude TODO
|
2002-02-12 22:10:46 +00:00
|
|
|
*/
|
2006-10-15 00:27:52 +00:00
|
|
|
|
|
|
|
|
/*! Define groups for Doxygen
|
|
|
|
|
* \defgroup rig Rig (transceiver) API
|
|
|
|
|
* \defgroup rotator Rotator API
|
|
|
|
|
* \defgroup utilities Utility Routines API
|
|
|
|
|
* \defgroup rig_internal Rig Internal API
|
|
|
|
|
*/
|
