New CSS file, added Doxygen logo to footer, tweaked hamlib.cfg.in for
Doxygen configuration.  Minor edits to index.doxygen.

Minor Doxygen edits to rotlist.h and network.c

git-svn-id: https://hamlib.svn.sourceforge.net/svnroot/hamlib/trunk@3035 7ae35d74-ebe9-4afe-98af-79ac388436b8
Hamlib-1.2.13
Nate Bargmann, N0NB 2011-02-03 02:52:17 +00:00
rodzic bbb40e1b2e
commit cf6443e3c4
6 zmienionych plików z 727 dodań i 57 usunięć

Wyświetl plik

@ -1,7 +1,8 @@
<!-- Footer for Doxygen HTML files -->
<hr>
<p><b>Hamlib documentation for version $projectnumber -- $datetime<br />
Project page: <a href="http://hamlib.org">http://hamlib.org</a></b>
<div class="doxy">Generated by&nbsp;<a href="http://www.doxygen.org/index.html"><img class="footer" src="$relpath$doxygen.png" alt="doxygen"/></a> $doxygenversion</small></address></div>
<p style="font-size: 75%">Hamlib documentation for version $projectnumber -- $datetime<br />
Project page: <a href="http://www.hamlib.org">http://www.hamlib.org</a><br />
</p>
</body>
</html>

Wyświetl plik

@ -1,4 +1,4 @@
## $Id: hamlib.cfg.in,v 1.6 2006-10-30 20:20:29 aa6e Exp $
## hamlib.cfg.in--converted into hamlib.cfg by configure
PROJECT_NAME = "Hamlib"
PROJECT_NUMBER = @VERSION@
@ -10,18 +10,14 @@ OUTPUT_LANGUAGE = English
GENERATE_HTML = YES
GENERATE_LATEX = NO
GENERATE_RTF = NO
GENERATE_MAN = YES
GENERATE_MAN = NO # User can set to YES for local man pages
MAN_EXTENSION = .3
# Input
CASE_SENSE_NAMES = NO
FULL_PATH_NAMES = NO
INPUT = @top_srcdir@/doc/index.doxygen \
@top_srcdir@/src/ @top_srcdir@/include/hamlib/ \
@top_srcdir@/tentec/orion.c @top_srcdir@/tentec/tentec.h \
@top_srcdir@/tentec/orion.h
#../c++/rigclass.cc
@top_srcdir@/src/ @top_srcdir@/include/hamlib/
INCLUDE_PATH = @top_srcdir@/include
@ -35,7 +31,7 @@ HTML_FOOTER = @top_srcdir@/doc/footer.html
EXTRACT_ALL = NO
EXTRACT_STATIC = NO
HIDE_UNDOC_MEMBERS = YES
HIDE_UNDOC_MEMBERS = NO
SHOW_INCLUDE_FILES = YES
INHERIT_DOCS = YES
ENABLED_SECTIONS = ""

Wyświetl plik

@ -1,25 +1,662 @@
BODY { font-size: 0.80em; width: 700px; }
H1 { text-align: center; }
A.qindex {}
A.qindexRef {}
A.el { font-size: 1.20em; text-decoration: none; font-weight: bold; font-family: courier,helvetica,serif }
A.elRef { font-size: 1.20em; font-weight: bold; font-family: courier,helvetica,serif }
A.code { font-size: 1.20em; text-decoration: none; font-weight: normal; color: #4444ee; font-family: courier,helvetica,serif }
A.codeRef { font-size: 1.20em;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: 1.20em; 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.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: 1.20em; font-family: courier,helvetica,serif }
FONT.keyword { color: #008000 }
FONT.keywordtype { color: #604020 }
FONT.keywordflow { color: #e08000 }
FONT.comment { color: #800000 }
FONT.preprocessor { color: #806020 }
FONT.stringliteral { color: #002080 }
FONT.charliteral { color: #008080 }
TD.INDEXVALUE { font-size: 0.80em; }
TD { font-size: 0.80em; }
/* The standard CSS for doxygen */
body, table, div, p, dl {
font-family: sans-serif;
font-size: 100%;
}
/* @group Heading Levels */
h1 {
font-size: 2.5em;
}
h2 {
font-size: 1.875em;
}
h3 {
font-size: 1.20em;
}
dt {
font-weight: bold;
}
div.multicol {
-moz-column-gap: 1em;
-webkit-column-gap: 1em;
-moz-column-count: 3;
-webkit-column-count: 3;
}
p.startli, p.startdd, p.starttd {
margin-top: 2px;
}
p.endli {
margin-bottom: 0px;
}
p.enddd {
margin-bottom: 4px;
}
p.endtd {
margin-bottom: 2px;
}
/* @end */
caption {
font-weight: bold;
}
span.legend {
font-size: 70%;
text-align: center;
}
h3.version {
font-size: 90%;
text-align: center;
}
div.qindex, div.navtab{
background-color: #EBEFF6;
border: 1px solid #A3B4D7;
text-align: center;
margin: 2px;
padding: 2px;
}
div.qindex, div.navpath {
width: 100%;
line-height: 140%;
}
div.navtab {
margin-right: 15px;
}
/* @group Link Styling */
a {
color: #3D578C;
font-weight: normal;
text-decoration: none;
}
.contents a:visited {
color: #4665A2;
}
a:hover {
text-decoration: none;
background-color: #f0f0fd;
}
a.qindex {
font-weight: bold;
}
a.qindexHL {
font-weight: bold;
background-color: #9CAFD4;
color: #ffffff;
border: 1px double #869DCA;
}
.contents a.qindexHL:visited {
color: #ffffff;
}
a.el {
font-weight: bold;
}
a.elRef {
}
a.code {
color: #4665A2;
}
a.codeRef {
color: #4665A2;
}
/* @end */
dl.el {
margin-left: -1cm;
}
.fragment {
font-family: monospace, fixed;
font-size: 105%;
}
pre.fragment {
border: 1px solid #C4CFE5;
background-color: #FBFCFD;
padding: 4px 6px;
margin: 4px 8px 4px 2px;
overflow: auto;
word-wrap: break-word;
font-size: 90%;
line-height: 125%;
}
div.ah {
background-color: black;
font-weight: bold;
color: #ffffff;
margin-bottom: 3px;
margin-top: 3px;
padding: 0.2em;
border: solid thin #333;
border-radius: 0.5em;
-webkit-border-radius: .5em;
-moz-border-radius: .5em;
-webkit-box-shadow: 2px 2px 3px #999;
-moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px;
background-image: -webkit-gradient(linear, left top, left bottom, from(#eee), to(#000),color-stop(0.3, #444));
background-image: -moz-linear-gradient(center top, #eee 0%, #444 40%, #000);
}
div.groupHeader {
margin-left: 16px;
margin-top: 12px;
margin-bottom: 6px;
font-weight: bold;
}
div.groupText {
margin-left: 16px;
font-style: italic;
}
body {
background: white;
color: black;
margin: 0;
}
div.contents {
margin-top: 10px;
margin-left: 10px;
margin-right: 10px;
}
td.indexkey {
background-color: #EBEFF6;
font-weight: bold;
border: 1px solid #C4CFE5;
margin: 2px 0px 2px 0;
padding: 2px 10px;
}
td.indexvalue {
background-color: #EBEFF6;
border: 1px solid #C4CFE5;
padding: 2px 10px;
margin: 2px 0px;
}
tr.memlist {
background-color: #EEF1F7;
}
p.formulaDsp {
text-align: center;
}
img.formulaDsp {
}
img.formulaInl {
vertical-align: middle;
}
div.center {
text-align: center;
margin-top: 0px;
margin-bottom: 0px;
padding: 0px;
}
div.center img {
border: 0px;
}
address.footer {
text-align: right;
padding-right: 12px;
}
img.footer {
border: 0px;
vertical-align: middle;
}
/* @group Code Colorization */
span.keyword {
color: #008000
}
span.keywordtype {
color: #604020
}
span.keywordflow {
color: #e08000
}
span.comment {
color: #800000
}
span.preprocessor {
color: #806020
}
span.stringliteral {
color: #002080
}
span.charliteral {
color: #008080
}
span.vhdldigit {
color: #ff00ff
}
span.vhdlchar {
color: #000000
}
span.vhdlkeyword {
color: #700070
}
span.vhdllogic {
color: #ff0000
}
/* @end */
/*
.search {
color: #003399;
font-weight: bold;
}
form.search {
margin-bottom: 0px;
margin-top: 0px;
}
input.search {
font-size: 75%;
color: #000080;
font-weight: normal;
background-color: #e8eef2;
}
*/
td.tiny {
font-size: 75%;
}
.dirtab {
padding: 4px;
border-collapse: collapse;
border: 1px solid #A3B4D7;
}
th.dirtab {
background: #EBEFF6;
font-weight: bold;
}
hr {
height: 0px;
border: none;
border-top: 1px solid #4A6AAA;
}
hr.footer {
height: 1px;
}
/* @group Member Descriptions */
table.memberdecls {
border-spacing: 0px;
padding: 0px;
}
.mdescLeft, .mdescRight,
.memItemLeft, .memItemRight,
.memTemplItemLeft, .memTemplItemRight, .memTemplParams {
background-color: #F9FAFC;
border: none;
margin: 4px;
padding: 1px 0 0 8px;
}
.mdescLeft, .mdescRight {
padding: 0px 8px 4px 8px;
color: #555;
}
.memItemLeft, .memItemRight, .memTemplParams {
border-top: 1px solid #C4CFE5;
}
.memItemLeft, .memTemplItemLeft {
white-space: nowrap;
}
.memTemplParams {
color: #4665A2;
white-space: nowrap;
}
/* @end */
/* @group Member Details */
/* Styles for detailed member documentation */
.memtemplate {
font-size: 80%;
color: #4665A2;
font-weight: normal;
margin-left: 3px;
}
.memnav {
background-color: #EBEFF6;
border: 1px solid #A3B4D7;
text-align: center;
margin: 2px;
margin-right: 15px;
padding: 2px;
}
.memitem {
padding: 0;
margin-bottom: 10px;
}
.memname {
white-space: nowrap;
font-weight: bold;
margin-left: 6px;
}
.memproto {
border-top: 1px solid #A8B8D9;
border-left: 1px solid #A8B8D9;
border-right: 1px solid #A8B8D9;
padding: 6px 0px 6px 0px;
color: #253555;
font-weight: bold;
text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9);
/* firefox specific markup */
-moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px;
-moz-border-radius-topright: 8px;
-moz-border-radius-topleft: 8px;
/* webkit specific markup */
-webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
-webkit-border-top-right-radius: 8px;
-webkit-border-top-left-radius: 8px;
background-image:url('nav_f.png');
background-repeat:repeat-x;
background-color: #E2E8F2;
}
.memdoc {
border-bottom: 1px solid #A8B8D9;
border-left: 1px solid #A8B8D9;
border-right: 1px solid #A8B8D9;
padding: 2px 5px;
background-color: #FBFCFD;
border-top-width: 0;
/* firefox specific markup */
-moz-border-radius-bottomleft: 8px;
-moz-border-radius-bottomright: 8px;
-moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px;
background-image: -moz-linear-gradient(center top, #FFFFFF 0%, #FFFFFF 60%, #F7F8FB 95%, #EEF1F7);
/* webkit specific markup */
-webkit-border-bottom-left-radius: 8px;
-webkit-border-bottom-right-radius: 8px;
-webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
background-image: -webkit-gradient(linear,center top,center bottom,from(#FFFFFF), color-stop(0.6,#FFFFFF), color-stop(0.60,#FFFFFF), color-stop(0.95,#F7F8FB), to(#EEF1F7));
}
.paramkey {
text-align: right;
}
.paramtype {
white-space: nowrap;
}
.paramname {
color: #602020;
white-space: nowrap;
}
.paramname em {
font-style: normal;
}
/* @end */
/* @group Directory (tree) */
/* for the tree view */
.ftvtree {
font-family: sans-serif;
margin: 0px;
}
/* these are for tree view when used as main index */
.directory {
font-size: 9pt;
font-weight: bold;
margin: 5px;
}
.directory h3 {
margin: 0px;
margin-top: 1em;
font-size: 11pt;
}
/*
The following two styles can be used to replace the root node title
with an image of your choice. Simply uncomment the next two styles,
specify the name of your image and be sure to set 'height' to the
proper pixel height of your image.
*/
/*
.directory h3.swap {
height: 61px;
background-repeat: no-repeat;
background-image: url("yourimage.gif");
}
.directory h3.swap span {
display: none;
}
*/
.directory > h3 {
margin-top: 0;
}
.directory p {
margin: 0px;
white-space: nowrap;
}
.directory div {
display: none;
margin: 0px;
}
.directory img {
vertical-align: -30%;
}
/* these are for tree view when not used as main index */
.directory-alt {
font-size: 100%;
font-weight: bold;
}
.directory-alt h3 {
margin: 0px;
margin-top: 1em;
font-size: 11pt;
}
.directory-alt > h3 {
margin-top: 0;
}
.directory-alt p {
margin: 0px;
white-space: nowrap;
}
.directory-alt div {
display: none;
margin: 0px;
}
.directory-alt img {
vertical-align: -30%;
}
/* @end */
div.dynheader {
margin-top: 8px;
}
address {
font-style: normal;
color: #2A3D61;
}
table.doxtable {
border-collapse:collapse;
}
table.doxtable td, table.doxtable th {
border: 1px solid #2D4068;
padding: 3px 7px 2px;
}
table.doxtable th {
background-color: #374F7F;
color: #FFFFFF;
font-size: 110%;
padding-bottom: 4px;
padding-top: 5px;
text-align:left;
}
.tabsearch {
top: 0px;
left: 10px;
height: 36px;
background-image: url('tab_b.png');
z-index: 101;
overflow: hidden;
font-size: 13px;
}
.navpath ul
{
font-size: 11px;
background-image:url('tab_b.png');
background-repeat:repeat-x;
height:30px;
line-height:30px;
color:#8AA0CC;
border:solid 1px #C2CDE4;
overflow:hidden;
margin:0px;
padding:0px;
}
.navpath li
{
list-style-type:none;
float:left;
padding-left:10px;
padding-right: 15px;
background-image:url('bc_s.png');
background-repeat:no-repeat;
background-position:right;
color:#364D7C;
}
.navpath a
{
height:32px;
display:block;
text-decoration: none;
outline: none;
}
.navpath a:hover
{
color:#6884BD;
}
div.summary
{
float: right;
font-size: 8pt;
padding-right: 5px;
width: 50%;
text-align: right;
}
div.summary a
{
white-space: nowrap;
}
div.header
{
background-image:url('nav_h.png');
background-repeat:repeat-x;
background-color: #F9FAFC;
margin: 0px;
border-bottom: 1px solid #C4CFE5;
}
div.headertitle
{
padding: 5px 5px 5px 10px;
}
div.doxy
{
float: right;
font-size: 75%;
}

Wyświetl plik

@ -1,19 +1,20 @@
/*! \mainpage Hamlib Distribution Information
/*! \mainpage Hamlib API Reference
\section auth Authors
St&eacute;phane Fillod and Frank Singleton
\n Documentation revisions by Martin Ewing, AA6E
St&eacute;phane Fillod, F8CFE, and Frank Singleton, VK3FCS and the Hamlib Group
\n Documentation revisions by Martin Ewing, AA6E, Nate Bargmann, N0NB
\section s1 Preface
This document describes the Hamlib library Application Programming Interface (API) for this distribution.
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., the API seen
by end-user application developers. You may navigate the documentation through the tabs
at the top of this page.
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.
Please report any problems to hamlib-developer@lists.sourceforge.net.
\section txtfil Distributed information files
@ -36,8 +37,10 @@ Other files: \subpage INSTALL;
\section lnks Internet links
\li http://hamlib.org - project web site, including list of supported rigs.
\li http://hamlib.sourceforge.net -- Sourceforge project info.
\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
\section slic Documentation License
@ -98,6 +101,4 @@ of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* \defgroup rotator Rotator API
* \defgroup utilities Utility Routines API
* \defgroup rig_internal Rig Internal API
* \defgroup tentec_orion Tentec Orion Backend
* \defgroup tentec Tentec Common Backend
*/

Wyświetl plik

@ -56,6 +56,12 @@
* be thought of as a hardware simulator and is very usefull for testing
* client applications.
*/
/*! \def ROT_MODEL_NETROTCTL
* \brief A macro that returns the model number for the Network backend.
*
* This backend allows use of the rotctld daemon through the normal
* Hamlib API.
*/
#define ROT_DUMMY 0
#define ROT_BACKEND_DUMMY "dummy"
#define ROT_MODEL_DUMMY ROT_MAKE_MODEL(ROT_DUMMY, 1)
@ -152,6 +158,24 @@
* The GS-232A backend can be used with rotators that support the
* GS-232A protocol.
*/
/*! \def ROT_MODEL_GS232
* \brief A macro that returns the model number of the GS-232 backend.
*
* The GS-232 backend can be used with rotators that support the
* GS-232 protocol.
*/
/*! \def ROT_MODEL_GS232B
* \brief A macro that returns the model number of the GS-232B backend.
*
* The GS-232B backend can be used with rotators that support the
* GS-232B protocol.
*/
/*! \def ROT_MODEL_F1TETRACKER
* \brief A macro that returns the model number of the F1TETRACKER backend.
*
* The F1TETRACKER backend can be used with rotators that support the
* F1TETRACKER protocol.
*/
#define ROT_GS232A 6
#define ROT_BACKEND_GS232A "gs232a"
#define ROT_MODEL_GS232A ROT_MAKE_MODEL(ROT_GS232A, 1)
@ -175,8 +199,14 @@
#define ROT_BACKEND_HEATHKIT "heathkit"
#define ROT_MODEL_HD1780 ROT_MAKE_MODEL(ROT_HEATHKIT, 1)
/*! \def ROT_MODEL_SPID
* \brief A macro that returns the model number of the SPID backend.
/*! \def ROT_MODEL_SPID_ROT2PROG
* \brief A macro that returns the model number of the ROT2PROG backend.
*
* The SPID backend can be used with rotators that support the SPID
* protocol.
*/
/*! \def ROT_MODEL_SPID_ROT1PROG
* \brief A macro that returns the model number of the ROT1PROG backend.
*
* The SPID backend can be used with rotators that support the SPID
* protocol.
@ -186,8 +216,8 @@
#define ROT_MODEL_SPID_ROT2PROG ROT_MAKE_MODEL(ROT_SPID, 1)
#define ROT_MODEL_SPID_ROT1PROG ROT_MAKE_MODEL(ROT_SPID, 2)
/*! \def ROT_MODEL_M2
* \brief A macro that returns the model number of the M2 backend.
/*! \def ROT_MODEL_RC2800
* \brief A macro that returns the model number of the RC2800 backend.
*
* The M2 backend can be used with rotators that support the RC2800
* protocol and alike.
@ -196,8 +226,14 @@
#define ROT_BACKEND_M2 "m2"
#define ROT_MODEL_RC2800 ROT_MAKE_MODEL(ROT_M2, 1)
/*! \def ROT_MODEL_ARS
* \brief A macro that returns the model number of the ARS backend.
/*! \def ROT_MODEL_RCI_AZEL
* \brief A macro that returns the model number of the RCI_AZEL backend.
*
* The ARS backend can be used with rotators that support the ARS
* protocol.
*/
/*! \def ROT_MODEL_RCI_AZ
* \brief A macro that returns the model number of the RCI_AZ backend.
*
* The ARS backend can be used with rotators that support the ARS
* protocol.

Wyświetl plik

@ -2,8 +2,6 @@
* Hamlib Interface - network communication low-level support
* Copyright (c) 2000-2010 by Stephane Fillod
*
* $Id: network.c,v 1.6 2008-11-05 23:02:00 fillods 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
* published by the Free Software Foundation; either version 2 of
@ -76,9 +74,10 @@ static int wsstarted;
* \brief Open network port using rig.state data
*
* Open Open network port using rig.state data.
* NB: the signal PIPE will be ignored for the whole application.
* NB: The signal PIPE will be ignored for the whole application.
*
* \param rp port data structure (must spec port id eg hostname:port)
* \param rp Port data structure (must spec port id eg hostname:port)
* \param default_port Default network socket port
* \return RIG_OK or < 0 if error
*/
int network_open(hamlib_port_t *rp, int default_port)