diff --git a/doc/footer.html b/doc/footer.html index 1125c3a48..96e94ef76 100644 --- a/doc/footer.html +++ b/doc/footer.html @@ -1,7 +1,7 @@
-

$projectname for version $projectnumber -- $datetime
-Project page: http://hamlib.org +

Hamlib documentation for version $projectnumber -- $datetime
+Project page: http://hamlib.org

diff --git a/doc/hamlib.cfg.in b/doc/hamlib.cfg.in index 792daf668..6968def39 100644 --- a/doc/hamlib.cfg.in +++ b/doc/hamlib.cfg.in @@ -1,4 +1,4 @@ -## $Id: hamlib.cfg.in,v 1.2 2006-10-12 19:19:47 aa6e Exp $ +## $Id: hamlib.cfg.in,v 1.3 2006-10-13 18:24:02 aa6e Exp $ PROJECT_NAME = "Hamlib - the C library reference" PROJECT_NUMBER = @VERSION@ @@ -34,7 +34,9 @@ INPUT = @top_srcdir@/doc/index.doxygen \ INCLUDE_PATH = @top_srcdir@/include -EXAMPLE_PATH = @top_srcdir@/tests/testrig.c +EXAMPLE_PATH = @top_srcdir@/tests/testrig.c \ + @top_srcdir@ + QUIET = YES HTML_STYLESHEET = @top_srcdir@/doc/hamlib.css diff --git a/doc/hamlib.css b/doc/hamlib.css index ea9967d4e..8386ef7f7 100644 --- a/doc/hamlib.css +++ b/doc/hamlib.css @@ -2,18 +2,18 @@ BODY { font-size: 0.80em; width: 700px; } H1 { text-align: center; } A.qindex {} A.qindexRef {} -A.el { font-size: 0.80em; text-decoration: none; font-weight: bold; font-family: courier,,helvetica,serif } -A.elRef { font-size: 0.80em; font-weight: bold; font-family: courier,helvetica,serif } -A.code { font-size: 0.80em; text-decoration: none; font-weight: normal; color: #4444ee; font-family: courier,helvetica,serif } -A.codeRef { font-size: 0.80em;font-weight: normal; color: #4444ee; font-family: courier,helvetica,serif } +A.el { font-size: 1.00em; text-decoration: none; font-weight: bold; font-family: courier,helvetica,serif } +A.elRef { font-size: 1.00em; font-weight: bold; font-family: courier,helvetica,serif } +A.code { font-size: 1.00em; text-decoration: none; font-weight: normal; color: #4444ee; font-family: courier,helvetica,serif } +A.codeRef { font-size: 1.00em;font-weight: normal; color: #4444ee; font-family: courier,helvetica,serif } A:hover { text-decoration: none; background-color: #f0f0fd; } DL.el { margin-left: -1cm } DIV.fragment { width: 100%; border: none; background-color: #eeeeee; font-family: courier,helvetica,serif } -DIV.ah { font-size: 0.80em; background-color: black; font-weight: bold; color: #ffffff; margin-bottom: 3px; margin-top: 3px; font-family: courier,helvetica,serif } -TD.md { font-size: 0.80em; background-color: #f2f2ff; font-weight: bold; font-family: courier,helvetica,serif } -TD.mdname { font-size: 0.80em; background-color: #f2f2ff; font-weight: bold; font-style: italic; font-family: courier,helvetica,serif } +DIV.ah { font-size: 1.00em; background-color: black; font-weight: bold; color: #ffffff; margin-bottom: 3px; margin-top: 3px; font-family: courier,helvetica,serif } +TD.md { font-size: 1.00em; background-color: #f2f2ff; font-weight: bold; font-family: courier,helvetica,serif } +TD.mdname { font-size: 1.00em; background-color: #f2f2ff; font-weight: bold; font-style: italic; font-family: courier,helvetica,serif } DIV.groupHeader { margin-left: 16px; margin-top: 12px; margin-bottom: 6px; font-weight: bold; font-family: courier,helvetica,serif } -DIV.groupText { margin-left: 16px; font-style: italic; font-size: 0.80em; font-family: courier,helvetica,serif } +DIV.groupText { margin-left: 16px; font-style: italic; font-size: 1.00em; font-family: courier,helvetica,serif } FONT.keyword { color: #008000 } FONT.keywordtype { color: #604020 } FONT.keywordflow { color: #e08000 } diff --git a/doc/index.doxygen b/doc/index.doxygen index 71d296d52..e29ac10cb 100644 --- a/doc/index.doxygen +++ b/doc/index.doxygen @@ -1,37 +1,102 @@ -/*! \page Index Preamble and License +/*! \mainpage Hamlib Distribution Information -\author Stephane Fillod -\author Frank Singleton +\section auth Authors -

Preface

+Stéphane Fillod and Frank Singleton +\n Documentation revisions by Martin Ewing, AA6E -

This document describes the \e Hamlib library API for 1.2.x.

+\section s1 Preface -

Each function of the API occuring in rig.c at the time of release -is documented here. Every effort was made to ensure all arguments -and return values are correct, but, as always, the source is definitive. -Errors are bound to have occurred and others will be blamed.

+This document describes the Hamlib library Application Programming Interface (API) for this distribution. -

Documentation License

-

This documentation is free; you can redistribute it without +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. + +Please report any problems to hamlib-developers@lists.sourceforge.net. + +\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 + +\li http://hamlib.org - project web site, including list of supported rigs. +\li http://hamlib.sourceforge.net -- Sourceforge project info. + +\section slic Documentation License + +This documentation is free; you can redistribute it without any restrictions. The modification or derived work must retain -copyright and list all authors.

+copyright and list all authors. -

This documentation is distributed in the hope that it will be +This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty -of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

+of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. -

API links

- +\subpage Obsol "Miscellaneous / obsolete" -

Internet links

- -

Edited by Martin Ewing, AA6E

+*/ +/*! \page Obsol Miscellaneous / Obsolete +\section apilnk API links + +\note Needs revision. This is a pretty useless section as it is! + +\li Page \ref hamlib explains the design of the general API. +\li Page \ref rig explains the design of the Rig (radio) API. +\li Page \ref rot explains the design of the Rotator API. +*/ +/*! \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 */