Skip to content

Commit

Permalink
Fix doxygen
Browse files Browse the repository at this point in the history
  • Loading branch information
@fedefava86
fedefava86 committed Jan 27, 2024
1 parent f91b102 commit 678994e
Show file tree
Hide file tree
Showing 1,299 changed files with 9,380 additions and 8,789 deletions.
36 changes: 30 additions & 6 deletions html/CROSS-COMPILE-EVO.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,14 @@
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>My Project: How to cross-compile DESERT for EvoLogics ARM Debian Sandbox</title>
<title>DESERT: How to cross-compile DESERT for EvoLogics ARM Debian Sandbox</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
Expand All @@ -21,7 +25,8 @@
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">My Project
<div id="projectname">DESERT
&#160;<span id="projectnumber">3.4.0</span>
</div>
</td>
</tr>
Expand All @@ -45,6 +50,23 @@
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('CROSS-COMPILE-EVO.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
Expand All @@ -59,7 +81,6 @@
</iframe>
</div>

</div><!-- top -->
<div class="PageDoc"><div class="header">
<div class="headertitle">
<div class="title">How to cross-compile DESERT for EvoLogics ARM Debian Sandbox </div> </div>
Expand Down Expand Up @@ -100,9 +121,12 @@ <h1><a class="anchor" id="CROSS-COMPILE-EVO-docker"></a>
<p>You will have a shell inside the running container with DESERT framework mounted on its filesystem, and you can now proceed to compile DESERT as in the previous section. At the end of the installation, you can exit the docker container shell (container will now die) and copy the *_buildCopy* folder inside your EvoLogics modem, as explained in the previous section </p>
</div></div><!-- contents -->
</div><!-- PageDoc -->
</div><!-- doc-content -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>
</html>
36 changes: 30 additions & 6 deletions html/CROSS-COMPILE-RPI.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,14 @@
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>My Project: How to cross-compile DESERT for Raspberry Pi Zero</title>
<title>DESERT: How to cross-compile DESERT for Raspberry Pi Zero</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
Expand All @@ -21,7 +25,8 @@
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">My Project
<div id="projectname">DESERT
&#160;<span id="projectnumber">3.4.0</span>
</div>
</td>
</tr>
Expand All @@ -45,6 +50,23 @@
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('CROSS-COMPILE-RPI.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
Expand All @@ -59,7 +81,6 @@
</iframe>
</div>

</div><!-- top -->
<div class="PageDoc"><div class="header">
<div class="headertitle">
<div class="title">How to cross-compile DESERT for Raspberry Pi Zero </div> </div>
Expand Down Expand Up @@ -98,9 +119,12 @@ <h1><a class="anchor" id="CROSS-COMPILE-RPI-docker"></a>
<p>You will have a shell inside the running container with DESERT framework mounted on its filesystem, and you can now proceed to compile DESERT as in the previous section. At the end of the installation, you can exit the docker container shell (container will now die) and copy the *_buildCopy* folder inside your Raspberry, as explained in the previous section </p>
</div></div><!-- contents -->
</div><!-- PageDoc -->
</div><!-- doc-content -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>
</html>
44 changes: 34 additions & 10 deletions html/DEV.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,14 @@
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>My Project: Developer guide</title>
<title>DESERT: Developer guide</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
Expand All @@ -21,7 +25,8 @@
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">My Project
<div id="projectname">DESERT
&#160;<span id="projectnumber">3.4.0</span>
</div>
</td>
</tr>
Expand All @@ -45,6 +50,23 @@
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('DEV.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
Expand All @@ -59,15 +81,14 @@
</iframe>
</div>

</div><!-- top -->
<div class="PageDoc"><div class="header">
<div class="headertitle">
<div class="title">Developer guide </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><h1><a class="anchor" id="DESMod"></a>
Structure of a DESERT module</h1>
<p>Each DESERT module derives either from another DESERT or ns-miracle module (e.g., UnderwaterPhysical derives from ns2-miracle UnderwaterMPhyBpsk) or from the base ns2-miracle Module class. In order to use it with tcl, in the cpp file you always need to create a static class that derives from TclClass and gives the name that will be used from tcl to create and bind an object of that module. For instance UnderwaterPhysical is “converted” in tcl using the following class</p>
<p>Each DESERT module derives either from another DESERT or ns-miracle module (e.g., <a class="el" href="classUnderwaterPhysical.html">UnderwaterPhysical</a> derives from ns2-miracle UnderwaterMPhyBpsk) or from the base ns2-miracle Module class. In order to use it with tcl, in the cpp file you always need to create a static class that derives from TclClass and gives the name that will be used from tcl to create and bind an object of that module. For instance <a class="el" href="classUnderwaterPhysical.html">UnderwaterPhysical</a> is “converted” in tcl using the following class</p>
<p><small> </p><pre class="fragment">static class UwPhysicalClass : public TclClass
{
public:
Expand All @@ -82,9 +103,9 @@
}
} class_module_uwphysical;
</pre><p> </small></p>
<p>The name "Module/UW/PHYSICAL" is the one that will be used in TCL to create and bind objects of type UnderwaterPhysical.</p>
<p>You can pass variables to and from tcl script and C++ class, by means of bind function, inside the constructor of your module class. To bind a variable you need to use the bind function inside the constructor of your module class. In example, in UnderwaterPhysical we bind the rx_power_ with bind("rx_power_consumption_", &amp;rx_power_); All bound variables need to be initialized to a default value in the *-defaults.tcl inside your folder.</p>
<p>Another way to communicate with the tcl script is to overwrite the command method, for example to get and set parameters of a module object. For more details, just check the UnderwaterPhysical::command method. It is usually best practice to call the father class’ command method at the end.</p>
<p>The name "Module/UW/PHYSICAL" is the one that will be used in TCL to create and bind objects of type <a class="el" href="classUnderwaterPhysical.html">UnderwaterPhysical</a>.</p>
<p>You can pass variables to and from tcl script and C++ class, by means of bind function, inside the constructor of your module class. To bind a variable you need to use the bind function inside the constructor of your module class. In example, in <a class="el" href="classUnderwaterPhysical.html">UnderwaterPhysical</a> we bind the rx_power_ with bind("rx_power_consumption_", &amp;rx_power_); All bound variables need to be initialized to a default value in the *-defaults.tcl inside your folder.</p>
<p>Another way to communicate with the tcl script is to overwrite the command method, for example to get and set parameters of a module object. For more details, just check the <a class="el" href="classUnderwaterPhysical.html#aec051803a5f4aa6fd2e8ff40a5ef411a" title="TCL command interpreter.">UnderwaterPhysical::command</a> method. It is usually best practice to call the father class’ command method at the end.</p>
<h1><a class="anchor" id="HowTo"></a>
How to add a new custom installer</h1>
<p>First of all, enter the installation folder:</p>
Expand Down Expand Up @@ -250,9 +271,12 @@ <h1><a class="anchor" id="newheader"></a>
<p>This last step is really important to have the right memory allocation done. Missing it could lead to unpredictable behavior, usually really hard to troubleshoot. </p>
</div></div><!-- contents -->
</div><!-- PageDoc -->
</div><!-- doc-content -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>
</html>
39 changes: 32 additions & 7 deletions html/Giovanni.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,14 @@
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>My Project: In memory of Giovanni Toso</title>
<title>DESERT: In memory of Giovanni Toso</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
Expand All @@ -21,7 +25,8 @@
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">My Project
<div id="projectname">DESERT
&#160;<span id="projectnumber">3.4.0</span>
</div>
</td>
</tr>
Expand All @@ -45,6 +50,23 @@
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('Giovanni.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
Expand All @@ -59,21 +81,24 @@
</iframe>
</div>

</div><!-- top -->
<div class="PageDoc"><div class="header">
<div class="headertitle">
<div class="title">In memory of Giovanni Toso </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>DESERT Underwater has been put together, tested, improved, and expanded over time also thanks to the continuous efforts of our beloved colleague and friend Giovanni Toso, who prematurely passed away in a car accident on August 10, 2014. DESERT 3.0 is the first major release after Giovanni's death, and is dedicated to his memory.</p>
<div class="textblock"><p>DESERT Underwater has been put together, tested, improved, and expanded over time also thanks to the continuous efforts of our beloved colleague and friend Giovanni Toso, who prematurely passed away in a car accident on August 10, 2014.</p>
<p>DESERT 3.0 is the first major release after Giovanni's death, and is dedicated to his memory.</p>
<div class="image">
<img src="./giovanni.jpeg" alt=""/>
</div>
</div></div><!-- contents -->
</div><!-- PageDoc -->
</div><!-- doc-content -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>
</html>
36 changes: 30 additions & 6 deletions html/INSTALL1.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,14 @@
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>My Project: Installation Guidelines</title>
<title>DESERT: Installation Guidelines</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
Expand All @@ -21,7 +25,8 @@
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">My Project
<div id="projectname">DESERT
&#160;<span id="projectnumber">3.4.0</span>
</div>
</td>
</tr>
Expand All @@ -45,6 +50,23 @@
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('INSTALL1.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
Expand All @@ -59,7 +81,6 @@
</iframe>
</div>

</div><!-- top -->
<div class="PageDoc"><div class="header">
<div class="headertitle">
<div class="title">Installation Guidelines </div> </div>
Expand Down Expand Up @@ -208,9 +229,12 @@ <h1><a class="anchor" id="todoafter"></a>
</p>
</div></div><!-- contents -->
</div><!-- PageDoc -->
</div><!-- doc-content -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>
</html>
Loading

0 comments on commit 678994e

Please sign in to comment.