diff --git a/doc/hamlib.cfg.in b/doc/hamlib.cfg.in index 746d02bab..9bca92e32 100644 --- a/doc/hamlib.cfg.in +++ b/doc/hamlib.cfg.in @@ -18,8 +18,8 @@ MAN_EXTENSION = .3 CASE_SENSE_NAMES = YES FULL_PATH_NAMES = NO INPUT = @top_srcdir@/doc/index.doxygen \ - @top_srcdir@/include/hamlib/ \ - @top_srcdir@/src/ + @top_srcdir@/include/hamlib/ \ + @top_srcdir@/src/ EXCLUDE = @top_srcdir@/src/amp_conf.h \ @top_srcdir@/include/hamlib/ampclass.h \ @@ -28,7 +28,11 @@ EXCLUDE = @top_srcdir@/src/amp_conf.h \ INCLUDE_PATH = @top_srcdir@/include EXAMPLE_PATH = @top_srcdir@/tests/testrig.c \ - @top_srcdir@ + @top_srcdir@ \ + @top_srcdir@/scripts/README.build-Windows \ + @top_srcdir@/scripts/build-w32.sh \ + @top_srcdir@/scripts/build-w64.sh + QUIET = YES diff --git a/doc/index.doxygen b/doc/index.doxygen index b464c99fe..34c9c69c2 100644 --- a/doc/index.doxygen +++ b/doc/index.doxygen @@ -10,7 +10,7 @@ Stéphane Fillod, F8CFE, and Frank Singleton, VK3FCS and the Hamlib Group This document describes the Hamlib library Application Programming Interface (API) for this distribution. -We attempt to document the complete API of the core modules of Hamlib, i.e., +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. @@ -21,9 +21,9 @@ Please report any problems to hamlib-developer@lists.sourceforge.net. These text files are distributed with the Hamlib package. Readme files: \subpage Rdme "General"; - \subpage Rdmebeta "Beta tester"; +\subpage Rdmebeta "Beta Tester"; \subpage Rdmedevel "Developer"; -\subpage Rdmewin32 "Win32" +\subpage Rdmewin "MS Windows" Other files: \subpage INSTALL; \subpage AUTHORS; @@ -33,14 +33,13 @@ Other files: \subpage INSTALL; \subpage NEWS; \subpage PLAN; \subpage THANKS; -\subpage TODO \section lnks Internet links -\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 +\li http://hamlib.org — Main project with links to releases, Wiki, and documentation including list of supported equipment. +\li https://github.com/Hamlib/Hamlib — GitHub repository via Web interface. +\li https://sourceforge.net/projects/hamlib/ — SourceForge.net project page. +\li https://sourceforge.net/p/hamlib/code/ — SourceForge Git repository via Web interface. \section slic Documentation License @@ -65,8 +64,16 @@ of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. /*! \page Rdmedevel README.developer \verbinclude README.developer */ -/*! \page Rdmewin32 README.win32 -\verbinclude README.win32 +/*! \page Rdmewin Cross-compiling Hamlib on Linux for MS Windows +This page contains the `scripts/README.build-Windows` instructions and the +`scripts/build-w32.sh` file that describe cross-compiling Hamlib for MS +Windows 32 bit on Debian GNU/Linux. +\section Build README.build-Windows +\verbinclude README.build-Windows +\subsection W32 The build-w32.sh script +\verbinclude build-w32.sh +\subsection W64 The build-w64.sh script +\verbinclude build-w64.sh */ /*! \page INSTALL INSTALL \verbinclude INSTALL @@ -92,14 +99,11 @@ of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. /*! \page THANKS THANKS \verbinclude THANKS */ -/*! \page TODO TO DO -\verbinclude TODO -*/ /*! Define groups for Doxygen - * \defgroup rig Rig (transceiver) API - * \defgroup rotator Rotator API - * \defgroup utilities Utility Routines API - * \defgroup rig_internal Rig Internal API - * \defgroup amplifier Amplifier API + * \defgroup rig Rig (transceiver) API + * \defgroup rotator Rotator API + * \defgroup utilities Utility Routines API + * \defgroup rig_internal Rig Internal API + * \defgroup amplifier Amplifier API */