mirror
/
Hamlib
kopia lustrzana https://github.com/Hamlib/Hamlib
1
0
Forkuj 0
Kod Zgłoszenia Projekty Wydania Wiki Aktywność

Include Windows build info and scripts to Doxygen 

Add these files as part of the Doxygen generated documentation.
pull/547/head
Nate Bargmann 2021-02-14 14:07:11 -06:00
rodzic bbb4354f2b
commit 3602c326cd
Nie znaleziono w bazie danych klucza dla tego podpisu
ID klucza GPG: F72625E2EDBED598
2 zmienionych plików z 29 dodań i 21 usunięć
Pokaż statystyki Ściągnij plik aktualizacji Ściągnij plik porównania Expand all files Collapse all files

10
doc/hamlib.cfg.in
Wyświetl plik

@ -18,8 +18,8 @@ MAN_EXTENSION = .3
CASE_SENSE_NAMES = YES CASE_SENSE_NAMES = YES
FULL_PATH_NAMES = NO FULL_PATH_NAMES = NO
INPUT = @top_srcdir@/doc/index.doxygen \ INPUT = @top_srcdir@/doc/index.doxygen \
@top_srcdir@/include/hamlib/ \ @top_srcdir@/include/hamlib/ \
@top_srcdir@/src/ @top_srcdir@/src/
EXCLUDE = @top_srcdir@/src/amp_conf.h \ EXCLUDE = @top_srcdir@/src/amp_conf.h \
@top_srcdir@/include/hamlib/ampclass.h \ @top_srcdir@/include/hamlib/ampclass.h \
@ -28,7 +28,11 @@ EXCLUDE = @top_srcdir@/src/amp_conf.h \
INCLUDE_PATH = @top_srcdir@/include INCLUDE_PATH = @top_srcdir@/include
EXAMPLE_PATH = @top_srcdir@/tests/testrig.c \ 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 QUIET = YES

40
doc/index.doxygen
Wyświetl plik

@ -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 This document describes the Hamlib library Application Programming Interface
(API) for this distribution. (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 the API seen by end-user application developers. You may navigate the
documentation through the tabs at the top of this page. 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. These text files are distributed with the Hamlib package.
Readme files: \subpage Rdme "General"; Readme files: \subpage Rdme "General";
\subpage Rdmebeta "Beta tester"; \subpage Rdmebeta "Beta Tester";
\subpage Rdmedevel "Developer"; \subpage Rdmedevel "Developer";
\subpage Rdmewin32 "Win32" \subpage Rdmewin "MS Windows"
Other files: \subpage INSTALL; Other files: \subpage INSTALL;
\subpage AUTHORS; \subpage AUTHORS;
@ -33,14 +33,13 @@ Other files: \subpage INSTALL;
\subpage NEWS; \subpage NEWS;
\subpage PLAN; \subpage PLAN;
\subpage THANKS; \subpage THANKS;
\subpage TODO
\section lnks Internet links \section lnks Internet links
\li http://www.hamlib.org -- project Wiki, including list of supported rigs. \li http://hamlib.org — Main project with links to releases, Wiki, and documentation including list of supported equipment.
\li http://sourceforge.net/projects/hamlib/ -- SourceForge.net project page. \li https://github.com/Hamlib/Hamlib — GitHub repository via Web interface.
\li http://hamlib.git.sourceforge.net/git/gitweb-index.cgi -- Git repository via Web \li https://sourceforge.net/projects/hamlib/ — SourceForge.net project page.
\li http://hamlib.svn.sourceforge.net/viewvc/hamlib/ -- SVN repository via Web \li https://sourceforge.net/p/hamlib/code/ — SourceForge Git repository via Web interface.
\section slic Documentation License \section slic Documentation License
@ -65,8 +64,16 @@ of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
/*! \page Rdmedevel README.developer /*! \page Rdmedevel README.developer
\verbinclude README.developer \verbinclude README.developer
*/ */
/*! \page Rdmewin32 README.win32 /*! \page Rdmewin Cross-compiling Hamlib on Linux for MS Windows
\verbinclude README.win32 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 /*! \page INSTALL INSTALL
\verbinclude INSTALL \verbinclude INSTALL
@ -92,14 +99,11 @@ of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
/*! \page THANKS THANKS /*! \page THANKS THANKS
\verbinclude THANKS \verbinclude THANKS
*/ */
/*! \page TODO TO DO
\verbinclude TODO
*/
/*! Define groups for Doxygen /*! Define groups for Doxygen
* \defgroup rig Rig (transceiver) API * \defgroup rig Rig (transceiver) API
* \defgroup rotator Rotator API * \defgroup rotator Rotator API
* \defgroup utilities Utility Routines API * \defgroup utilities Utility Routines API
* \defgroup rig_internal Rig Internal API * \defgroup rig_internal Rig Internal API
* \defgroup amplifier Amplifier API * \defgroup amplifier Amplifier API
*/ */