From d4bc60be0bc6e6b3288d8ebe5f245bc9e71ee846 Mon Sep 17 00:00:00 2001 From: Nate Bargmann Date: Fri, 5 Feb 2021 20:36:49 -0600 Subject: [PATCH] Update Doxygen files The latest Doxygen has changed the footer.html substantially from the much older version we were using. Add some Hamlib project specific information to it. Align hamlib.cfg.in to the latest Doxygen. Reduce hamlib.css to only those elements needed for Hamlib customization. Add hamlib.png as a project logo. --- doc/footer.html | 34 ++- doc/hamlib.cfg.in | 49 ++-- doc/hamlib.css | 671 ++-------------------------------------------- doc/hamlib.png | Bin 0 -> 2296 bytes 4 files changed, 72 insertions(+), 682 deletions(-) create mode 100644 doc/hamlib.png diff --git a/doc/footer.html b/doc/footer.html index 38c4e29ae..41c5ce948 100644 --- a/doc/footer.html +++ b/doc/footer.html @@ -1,8 +1,30 @@ - -
-
Generated by doxygen $doxygenversion
-

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

+ + + + + + +
+
+ + $generatedby doxygen $doxygenversion + +
+ + +
diff --git a/doc/hamlib.cfg.in b/doc/hamlib.cfg.in index 07d1eed0f..e2225d8c6 100644 --- a/doc/hamlib.cfg.in +++ b/doc/hamlib.cfg.in @@ -1,7 +1,8 @@ -## hamlib.cfg.in--converted into hamlib.cfg by configure +## hamlib.cfg.in--converted into hamlib.cfg by config.status -PROJECT_NAME = "Hamlib" +PROJECT_NAME = Hamlib PROJECT_NUMBER = @VERSION@ +PROJECT_LOGO = @top_srcdir@/doc/hamlib.png # Output OUTPUT_DIRECTORY= . @@ -14,31 +15,31 @@ 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/ +CASE_SENSE_NAMES = YES +FULL_PATH_NAMES = NO +INPUT = @top_srcdir@/doc/index.doxygen \ + @top_srcdir@/include/hamlib/ \ + @top_srcdir@/src/ -INCLUDE_PATH = @top_srcdir@/include +INCLUDE_PATH = @top_srcdir@/include -EXAMPLE_PATH = @top_srcdir@/tests/testrig.c \ - @top_srcdir@ +EXAMPLE_PATH = @top_srcdir@/tests/testrig.c \ + @top_srcdir@ -QUIET = YES +QUIET = YES -HTML_STYLESHEET = @top_srcdir@/doc/hamlib.css -HTML_FOOTER = @top_srcdir@/doc/footer.html +HTML_FOOTER = @top_srcdir@/doc/footer.html +HTML_EXTRA_STYLESHEET = @top_srcdir@/doc/hamlib.css -EXTRACT_ALL = NO -EXTRACT_STATIC = NO -HIDE_UNDOC_MEMBERS = NO -SHOW_INCLUDE_FILES = YES -INHERIT_DOCS = YES -ENABLED_SECTIONS = "" -PREDEFINED = DOXYGEN "DOC_HIDDEN" -JAVADOC_AUTOBRIEF = NO -OPTIMIZE_OUTPUT_FOR_C = YES # doxygen 1.2.6 option - -MAN_LINKS = NO -MACRO_EXPANSION = YES +EXTRACT_ALL = NO +EXTRACT_STATIC = NO +HIDE_UNDOC_MEMBERS = NO +SHOW_INCLUDE_FILES = YES +INHERIT_DOCS = YES +ENABLED_SECTIONS = "" +PREDEFINED = DOXYGEN "DOC_HIDDEN" +JAVADOC_AUTOBRIEF = NO +OPTIMIZE_OUTPUT_FOR_C = YES +MAN_LINKS = NO +MACRO_EXPANSION = YES diff --git a/doc/hamlib.css b/doc/hamlib.css index 554d62615..d6edeb7ab 100644 --- a/doc/hamlib.css +++ b/doc/hamlib.css @@ -1,662 +1,29 @@ -/* The standard CSS for doxygen */ +/* Custom CSS for Hamlib used by the Doxygen generated HTML pages. */ -body, table, div, p, dl { - font-family: sans-serif; - font-size: 100%; -} +/* Add padding around the Hamlib logo in the page header. */ -/* @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 +#projectlogo { - 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; + padding-right: 0.85em; + padding-left: 0.8em; + padding-top: 0.5em; + padding-bottom: 0.5em; + } -.navpath li + +/* Align the Hamlib footer elements to the left and right and pad + * from the screen edge to align with other page padding. */ + +.footer p.alignleft { - 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; + float: left; + font-size: 75%; + padding-left: 1.5em; } -.navpath a +.footer p.alignright { - 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%; + float: right; + padding-right: 0.85em; } diff --git a/doc/hamlib.png b/doc/hamlib.png new file mode 100644 index 0000000000000000000000000000000000000000..70992fef7d49ac81b8396b9c459fada9417f08e6 GIT binary patch literal 2296 zcmV)pM3A2V~%?A@0i>xXEig0k8l zckj-e`R2?y-}%nK*|TTKJLyBoJM41@(0U)f>RXhOAOQ-5mJlPNRD=*&n6VtIprSgHvaL&sHiQ7^?gOGOC*Rj|?XYM2mdEDENfAAMgHiuGu~ zFjy+0A3a~&K?KuakuU*@o~H`-^1ZDN2mqy=f8r@Iw-CN>f9&{C;`{#8O!n~?i7#Rw zeJHg5Zew5?>_wwuR%rG#B_Z~wj)xzT9b1y04SqJxp@7+%dc7Pp~%0Bm! z(?0-|njP)2V@HT-62t(jn7(!U`Cn5Oc6+u(j=qn@BKEm|-ahj@5*0i8fu=`#D|R*z z)HIpkRtmylB9&f%QI<;bNK&5;VkvYGEJF+qt9+iPn|ZofxvqEZh8|FLlEHa2$!dx6 z$MV1bYwnfT3DNn?5^-Tyk_ZWyhP<`l_6-0x%)5J7QvwXr9~=^s)4aPw*>)Ka5iH$8 zqmklY{;`-Vuw;Vo+OdXv8Xp+|5t6keL+{xiI<(K)wS!1mAN7PXF+SyvjvMJ#-oBNk zTg*(GH!KglthI&T)q%cnF20FN9H2KA+P{|wDYA3MySA}Z6Csii*nA8D zpf6OufR2Mjcj;e*2wA**m71nMF*W|VZv>o4BN6BFRrG4mq2wXfmW~~JP)yB+?>mG# zt)np;nQ%iOgcl@eojE@Yj)>(;?NK^3d*Vll6C zBM~Q!^J~qZ4jfZIx%{T&HqZA5ZYa+;JKBw|445XEhS8ZZJKIqTfAA*SZu!)zMi>Rg z%FmRp0c&+YXcv`VsMS%WRKZro0{TKH{6g0L+rN}&n>)H_B8sj@d_lvOwYx`oPVvGe zF*ByJ#J zkbFyur<(&#Cyc83tUq%LC^fn=G!l}zfa#91P zwjI=b4E0A=&N~3Dvz860&;)vZElTvP!jds%Q!8GspJh7Fmlv;f22|m$F>8&NcSQdG zS=SNB&~?tcI%Zj&tFJT5$3U4{HwOrja7IltkbI5gi>3xj^>R=VNkCAc&iQJQu}s~) zAXceCvxeudvCkENkPybyV&0pWCICifJ4C{(V4~m;jVj00{s_vJUPEhpqbpO^`JDS> zlPa4dj6vWw%2*=C+R~bY8ffYjfRv(%Sn=%n$!~ri7|;Cdbol;*Dpy#tC#7g4I{n=r zIoGaGBSB4r04Ud0zHMf@x?lLECM2a;JbL@|vx_gk%Hj!?%WFKbnAzDD`|y$YBfX6j zQKKW{G#b_AQ1@S}NhKj84;(T&+R*de{y~BmzGpX$$5=8^*9d4`Kto}cY6`#iFrgqu zC%v)Bxu?$1L@f4+hcR!H4fSOKCZ!ri9{{>;%a=b(lZoQrFHU^n6iS);^vUS)2i1I5 zIZj<`tE&w}BW;g;n^3AH%GV$DhR2GR`r@DLRfzBw=%ETGEhZ6F-VO*_6>PbX#ax~k zywMaL;8H5rVaX&}4b6W6s1(KJGp+lHboqS)aE7`3)Ttj3O6A0~%I4!AI+8f~uu3c4nJpzGSXYj?u;%VD-iJp zk?4#3JXg)Pe*7d7QJJOyBHLd*1K|)@*6d?XIzyKzX`)t$5Hk1ErxhufE!}th<{9)v zm8+DS6C)E7UpZBB2V>C$i$#;4Imx@)bwf{As3M{(cS5E~cxj3+ z5+6GrnK(pDLpKjWY)QpZ2_mt==3e;zgEVA8Boc5paBeiG!Veta+q=+N1x>>?2uy=U zqXg9om!e$E2gRJmW1yoFYh!?*R6!lBhM?X<#g6U^q(sN7^(q_Up^}qCalUj{uv~s= zb`FjsyI2N;)r*C?0oC%N^7UgNP;i^Quqs^zvvnAOG1y3X*(B555&8dffc^vB37-om S?cGfP0000