Chore/doxygen update build (#845)

* Updated doxygen header, footer, and stylesheet files, and Makefile recipes * Updated the bacnet.sourceforge.net website. * Updated wording in README
2024-11-06 05:53:04 -06:00
parent bfe0f65953
commit e31350f6e9
20 changed files with 5241 additions and 1726 deletions
@@ -1,7 +0,0 @@
-<hr size="1"/><address style="text-align: right;"><small>
-<img class="footer" src="BACnet_sm.png" alt="BACnet logo"/>
-<!-- Break the small and then resume it -->
-</small><b>BACnet-stack API documentation</b><small><br>
-Generated on $datetime for $projectname by&nbsp;<a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.png" alt="doxygen"/></a> $doxygenversion</small></address>
-</body>
-</html>
@@ -1,12 +0,0 @@
-<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml">
-<head>
-<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
-<title>$title</title>
-<link href="$relpath$tabs.css" rel="stylesheet" type="text/css"/>
-<link href="$relpath$search/search.css" rel="stylesheet" type="text/css"/>
-<script type="text/javaScript" src="$relpath$search/search.js"></script>
-<link href="$relpath$doxygen.css" rel="stylesheet" type="text/css">
-</head>
-<body onload='searchBox.OnSelectItem(0);'>
@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="utf-8"?>
+<browserconfig>
+  <msapplication>
+    <tile>
+      <square70x70logo src="/favicon-70.png"/>
+      <square150x150logo src="/favicon-150.png"/>
+      <square310x310logo src="/favicon-310.png"/>
+      <TileColor>#FFFFFF</TileColor>
+    </tile>
+  </msapplication>
+</browserconfig>
@@ -0,0 +1,52 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+<html>
+<head>
+  <meta name="generator" content=
+  "HTML Tidy for HTML5 for Linux version 5.4.0">
+  <meta http-equiv="CONTENT-TYPE" content=
+  "text/html; charset=utf-8">
+  <title>BACnet MS/TP Wireshark Live Capture</title>
+</head>
+<body>
+  <p><a href="https://www.wireshark.org/">Wireshark</a> 2.0 brought
+  some new features, including <a href=
+  "https://www.wireshark.org/docs/man-pages/extcap.html">extcap</a>.
+  Extcap allows an external application to capture packets and move
+  them into Wireshark via a pipe. It is the perfect feature for
+  serial packets, such as BACnet MS/TP on RS-485, which don’t have
+  a network interface.</p>
+  <p>How does it work? After installing version Wireshark 2.0 or
+  later, find the Extcap folder on your computer. The folder is
+  listed under Wireshark Help About Folders menu option.</p>
+  <p><a href=
+  "http://steve.kargs.net/wp-content/uploads/2016/09/Help-About-Wireshark-Folders.png">
+  <img src="./images/Help-About-Wireshark-Folders-300x141.png" alt=
+  "help-about-wireshark-folders"></a></p>
+  <p>Copy <a href=
+  "https://sourceforge.net/projects/bacnet/files/bacnet-tools/">mstpcap.exe</a>
+  into the Extcap folder (create the folder if it doesn’t
+  exist).</p>
+  <p><a href=
+  "http://steve.kargs.net/wp-content/uploads/2016/09/Program-Files_Wireshark_extcap.png">
+  <img src="./images/Program-Files_Wireshark_extcap-300x131.png"
+  alt="program-files_wireshark_extcap"></a></p>
+  <p>Run Wireshark, and notice the new BACnet MS/TP Interfaces
+  associated with each serial port.</p>
+  <p><a href=
+  "http://steve.kargs.net/wp-content/uploads/2016/09/Wireshark-Interface-List.png">
+  <img src="./images/Wireshark-Interface-List-229x300.png" alt=
+  "wireshark-interface-list"></a></p>
+  <p>Adjust the MS/TP Baud Rate for the particular interface.</p>
+  <p><a href=
+  "http://steve.kargs.net/wp-content/uploads/2016/09/Wireshark-MSTP-Interface-Settings.png">
+  <img src="./images/Wireshark-MSTP-Interface-Settings-300x199.png"
+  alt="wireshark-mstp-interface-settings"></a></p>
+  <p>Start or Stop captures using the Capture Start or Capture Stop
+  options after selecting the Interface.</p>
+  <p><a href=
+  "http://steve.kargs.net/wp-content/uploads/2016/09/BACnet_MS_TP_on_COM6_Wireshark_Start_Capture.png">
+  <img src=
+  "./images/BACnet_MS_TP_on_COM6_Wireshark_Start_Capture-300x97.png"
+  alt="bacnet_ms_tp_on_com6_wireshark_start_capture"></a></p>
+</body>
+</html>
@@ -1,16 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml">
-<head>
-<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
-<title>BAC-stack</title>
-</head>
-<frameset cols="250,*">
-  <frame src="html/tree.html" name="treefrm"/>
-  <frame src="html/main.html" name="basefrm"/>
-  <noframes>
-    <body>
-    <a href="html/main.html">Frames are disabled. Click here to go to the main page.</a>
-    </body>
-  </noframes>
-</frameset>
-</html>
@@ -0,0 +1,17 @@
+<!-- HTML footer for doxygen 1.9.1-->
+<!-- start footer part -->
+<!--BEGIN GENERATE_TREEVIEW-->
+<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
+  <ul>
+    $navpath
+    <li class="footer">$generatedby <a href="https://www.doxygen.org/index.html"><img class="footer" src="$relpath^doxygen.svg" width="104" height="31" alt="doxygen"/></a> $doxygenversion </li>
+  </ul>
+</div>
+<!--END GENERATE_TREEVIEW-->
+<!--BEGIN !GENERATE_TREEVIEW-->
+<hr class="footer"/><address class="footer"><small>
+$generatedby&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="$relpath^doxygen.svg" width="104" height="31" alt="doxygen"/></a> $doxygenversion
+</small></address>
+<!--END !GENERATE_TREEVIEW-->
+</body>
+</html>
@@ -0,0 +1,56 @@
+<!-- HTML header for doxygen 1.9.1-->
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<meta http-equiv="X-UA-Compatible" content="IE=9"/>
+<meta name="generator" content="Doxygen $doxygenversion"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<!--BEGIN PROJECT_NAME--><title>$projectname: $title</title><!--END PROJECT_NAME-->
+<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
+<link href="$relpath^tabs.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="$relpath^jquery.js"></script>
+<script type="text/javascript" src="$relpath^dynsections.js"></script>
+$treeview
+$search
+$mathjax
+<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
+$extrastylesheet
+</head>
+<body>
+<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
+
+<!--BEGIN TITLEAREA-->
+<div id="titlearea">
+<table cellspacing="0" cellpadding="0">
+ <tbody>
+ <tr style="height: 56px;">
+  <!--BEGIN PROJECT_LOGO-->
+  <td id="projectlogo"><img alt="Logo" src="$relpath^$projectlogo"/></td>
+  <!--END PROJECT_LOGO-->
+  <!--BEGIN PROJECT_NAME-->
+  <td id="projectalign" style="padding-left: 0.5em;">
+   <div id="projectname">$projectname
+   <!--BEGIN PROJECT_NUMBER-->&#160;<span id="projectnumber">$projectnumber</span><!--END PROJECT_NUMBER-->
+   </div>
+   <!--BEGIN PROJECT_BRIEF--><div id="projectbrief">$projectbrief</div><!--END PROJECT_BRIEF-->
+  </td>
+  <!--END PROJECT_NAME-->
+  <!--BEGIN !PROJECT_NAME-->
+   <!--BEGIN PROJECT_BRIEF-->
+    <td style="padding-left: 0.5em;">
+    <div id="projectbrief">$projectbrief</div>
+    </td>
+   <!--END PROJECT_BRIEF-->
+  <!--END !PROJECT_NAME-->
+  <!--BEGIN DISABLE_INDEX-->
+   <!--BEGIN SEARCHENGINE-->
+   <td>$searchbox</td>
+   <!--END SEARCHENGINE-->
+  <!--END DISABLE_INDEX-->
+ </tr>
+ </tbody>
+</table>
+</div>
+<!--END TITLEAREA-->
+<!-- end header part -->