William/Senior-Design-Project_WMU-Sunseeker_Altium-Designer
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added some info on how we can add images to the documentation

Browse Source
This commit is contained in:
William Miceli
2021-02-06 19:04:10 -05:00
parent bd949d1a68
commit 1812b4174b
30 changed files with 63 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
Documentation/html/Funny-Cat-Hidden.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 154 KiB

2
Documentation/html/_9_hardware_8markdown.html
View File

@@ -98,7 +98,7 @@ $(document).ready(function(){initNavTree('_9_hardware_8markdown.html',''); initR
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul> <ul>
<li class="navelem"><a class="el" href="_9_hardware_8markdown.html">!Hardware.markdown</a></li> <li class="navelem"><a class="el" href="_9_hardware_8markdown.html">!Hardware.markdown</a></li>
<li class="footer">Generated on Wed Feb 3 2021 17:04:16 for 2020-2021 Sunseeker Telemetry and Lighting System 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> <li class="footer">Generated on Sat Feb 6 2021 19:02:29 for 2020-2021 Sunseeker Telemetry and Lighting System 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> </ul>
</div> </div>
</body> </body>

2
Documentation/html/_9_software_8markdown.html
View File

@@ -98,7 +98,7 @@ $(document).ready(function(){initNavTree('_9_software_8markdown.html',''); initR
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul> <ul>
<li class="navelem"><a class="el" href="_9_software_8markdown.html">!Software.markdown</a></li> <li class="navelem"><a class="el" href="_9_software_8markdown.html">!Software.markdown</a></li>
<li class="footer">Generated on Wed Feb 3 2021 17:04:16 for 2020-2021 Sunseeker Telemetry and Lighting System 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> <li class="footer">Generated on Sat Feb 6 2021 19:02:29 for 2020-2021 Sunseeker Telemetry and Lighting System 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> </ul>
</div> </div>
</body> </body>

2
Documentation/html/_design_01_choices_8markdown.html
View File

@@ -98,7 +98,7 @@ $(document).ready(function(){initNavTree('_design_01_choices_8markdown.html','')
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul> <ul>
<li class="navelem"><a class="el" href="_design_01_choices_8markdown.html">Design Choices.markdown</a></li> <li class="navelem"><a class="el" href="_design_01_choices_8markdown.html">Design Choices.markdown</a></li>
<li class="footer">Generated on Wed Feb 3 2021 17:04:16 for 2020-2021 Sunseeker Telemetry and Lighting System 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> <li class="footer">Generated on Sat Feb 6 2021 19:02:29 for 2020-2021 Sunseeker Telemetry and Lighting System 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> </ul>
</div> </div>
</body> </body>

2
Documentation/html/_device_01_specifications_8markdown.html
View File

@@ -98,7 +98,7 @@ $(document).ready(function(){initNavTree('_device_01_specifications_8markdown.ht
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul> <ul>
<li class="navelem"><a class="el" href="_device_01_specifications_8markdown.html">Device Specifications.markdown</a></li> <li class="navelem"><a class="el" href="_device_01_specifications_8markdown.html">Device Specifications.markdown</a></li>
<li class="footer">Generated on Wed Feb 3 2021 17:04:16 for 2020-2021 Sunseeker Telemetry and Lighting System 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> <li class="footer">Generated on Sat Feb 6 2021 19:02:29 for 2020-2021 Sunseeker Telemetry and Lighting System 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> </ul>
</div> </div>
</body> </body>

2
Documentation/html/_documentation_01_guide_8markdown.html
View File

@@ -98,7 +98,7 @@ $(document).ready(function(){initNavTree('_documentation_01_guide_8markdown.html
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul> <ul>
<li class="navelem"><a class="el" href="_documentation_01_guide_8markdown.html">Documentation Guide.markdown</a></li> <li class="navelem"><a class="el" href="_documentation_01_guide_8markdown.html">Documentation Guide.markdown</a></li>
<li class="footer">Generated on Wed Feb 3 2021 17:04:16 for 2020-2021 Sunseeker Telemetry and Lighting System 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> <li class="footer">Generated on Sat Feb 6 2021 19:02:29 for 2020-2021 Sunseeker Telemetry and Lighting System 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> </ul>
</div> </div>
</body> </body>

2
Documentation/html/_r_e_a_d_m_e_8markdown.html
View File

@@ -98,7 +98,7 @@ $(document).ready(function(){initNavTree('_r_e_a_d_m_e_8markdown.html',''); init
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul> <ul>
<li class="navelem"><a class="el" href="_r_e_a_d_m_e_8markdown.html">README.markdown</a></li> <li class="navelem"><a class="el" href="_r_e_a_d_m_e_8markdown.html">README.markdown</a></li>
<li class="footer">Generated on Wed Feb 3 2021 17:04:16 for 2020-2021 Sunseeker Telemetry and Lighting System 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> <li class="footer">Generated on Sat Feb 6 2021 19:02:29 for 2020-2021 Sunseeker Telemetry and Lighting System 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> </ul>
</div> </div>
</body> </body>

2
Documentation/html/design_choices.html
View File

@@ -142,7 +142,7 @@ Microcontroller Peripheral Connections</h1>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul> <ul>
<li class="navelem"><a class="el" href="hardware.html">Hardware</a></li> <li class="navelem"><a class="el" href="hardware.html">Hardware</a></li>
<li class="footer">Generated on Wed Feb 3 2021 17:04:16 for 2020-2021 Sunseeker Telemetry and Lighting System 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> <li class="footer">Generated on Sat Feb 6 2021 19:02:29 for 2020-2021 Sunseeker Telemetry and Lighting System 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> </ul>
</div> </div>
</body> </body>

2
Documentation/html/device_specifications.html
View File

@@ -237,7 +237,7 @@ Inertial Measurement Unit: TDK InvenSense ICM-20600</h2>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul> <ul>
<li class="navelem"><a class="el" href="hardware.html">Hardware</a></li> <li class="navelem"><a class="el" href="hardware.html">Hardware</a></li>
<li class="footer">Generated on Wed Feb 3 2021 17:04:16 for 2020-2021 Sunseeker Telemetry and Lighting System 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> <li class="footer">Generated on Sat Feb 6 2021 19:02:29 for 2020-2021 Sunseeker Telemetry and Lighting System 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> </ul>
</div> </div>
</body> </body>

2
Documentation/html/dir_4e9c05acfa2c3671b8618fcb95d57d96.html
View File

@@ -104,7 +104,7 @@ Directories</h2></td></tr>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul> <ul>
<li class="navelem"><a class="el" href="dir_4e9c05acfa2c3671b8618fcb95d57d96.html">Software</a></li> <li class="navelem"><a class="el" href="dir_4e9c05acfa2c3671b8618fcb95d57d96.html">Software</a></li>
<li class="footer">Generated on Wed Feb 3 2021 17:04:16 for 2020-2021 Sunseeker Telemetry and Lighting System 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> <li class="footer">Generated on Sat Feb 6 2021 19:02:29 for 2020-2021 Sunseeker Telemetry and Lighting System 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> </ul>
</div> </div>
</body> </body>

2
Documentation/html/dir_6cc751a9e685a986d41d35de353de328.html
View File

@@ -98,7 +98,7 @@ $(document).ready(function(){initNavTree('dir_6cc751a9e685a986d41d35de353de328.h
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul> <ul>
<li class="navelem"><a class="el" href="dir_6cc751a9e685a986d41d35de353de328.html">Hardware</a></li> <li class="navelem"><a class="el" href="dir_6cc751a9e685a986d41d35de353de328.html">Hardware</a></li>
<li class="footer">Generated on Wed Feb 3 2021 17:04:16 for 2020-2021 Sunseeker Telemetry and Lighting System 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> <li class="footer">Generated on Sat Feb 6 2021 19:02:29 for 2020-2021 Sunseeker Telemetry and Lighting System 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> </ul>
</div> </div>
</body> </body>

2
Documentation/html/dir_70428d3c5958c16802133545478a5cfb.html
View File

@@ -104,7 +104,7 @@ Directories</h2></td></tr>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul> <ul>
<li class="navelem"><a class="el" href="dir_4e9c05acfa2c3671b8618fcb95d57d96.html">Software</a></li><li class="navelem"><a class="el" href="dir_70428d3c5958c16802133545478a5cfb.html">Code Composer Studio Workspace</a></li> <li class="navelem"><a class="el" href="dir_4e9c05acfa2c3671b8618fcb95d57d96.html">Software</a></li><li class="navelem"><a class="el" href="dir_70428d3c5958c16802133545478a5cfb.html">Code Composer Studio Workspace</a></li>
<li class="footer">Generated on Wed Feb 3 2021 17:04:16 for 2020-2021 Sunseeker Telemetry and Lighting System 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> <li class="footer">Generated on Sat Feb 6 2021 19:02:29 for 2020-2021 Sunseeker Telemetry and Lighting System 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> </ul>
</div> </div>
</body> </body>

2
Documentation/html/dir_7795a02a4813dcd036f04e5f7854f185.html
View File

@@ -98,7 +98,7 @@ $(document).ready(function(){initNavTree('dir_7795a02a4813dcd036f04e5f7854f185.h
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul> <ul>
<li class="navelem"><a class="el" href="dir_7795a02a4813dcd036f04e5f7854f185.html">Meta</a></li> <li class="navelem"><a class="el" href="dir_7795a02a4813dcd036f04e5f7854f185.html">Meta</a></li>
<li class="footer">Generated on Wed Feb 3 2021 17:04:16 for 2020-2021 Sunseeker Telemetry and Lighting System 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> <li class="footer">Generated on Sat Feb 6 2021 19:02:29 for 2020-2021 Sunseeker Telemetry and Lighting System 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> </ul>
</div> </div>
</body> </body>

2
Documentation/html/dir_ef94255a62432ae865475b379d8bd501.html
View File

@@ -104,7 +104,7 @@ Files</h2></td></tr>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul> <ul>
<li class="navelem"><a class="el" href="dir_4e9c05acfa2c3671b8618fcb95d57d96.html">Software</a></li><li class="navelem"><a class="el" href="dir_70428d3c5958c16802133545478a5cfb.html">Code Composer Studio Workspace</a></li><li class="navelem"><a class="el" href="dir_ef94255a62432ae865475b379d8bd501.html">SunseekerTelemetryAndLightingSystem</a></li> <li class="navelem"><a class="el" href="dir_4e9c05acfa2c3671b8618fcb95d57d96.html">Software</a></li><li class="navelem"><a class="el" href="dir_70428d3c5958c16802133545478a5cfb.html">Code Composer Studio Workspace</a></li><li class="navelem"><a class="el" href="dir_ef94255a62432ae865475b379d8bd501.html">SunseekerTelemetryAndLightingSystem</a></li>
<li class="footer">Generated on Wed Feb 3 2021 17:04:16 for 2020-2021 Sunseeker Telemetry and Lighting System 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> <li class="footer">Generated on Sat Feb 6 2021 19:02:29 for 2020-2021 Sunseeker Telemetry and Lighting System 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> </ul>
</div> </div>
</body> </body>

11
Documentation/html/documentation_guide.html
View File

@@ -111,17 +111,24 @@ Important Notes</h1>
For Consistency</h2> For Consistency</h2>
<ul> <ul>
<li>Please make sure the internal names ("tags") of files are using "camelCase"<ul> <li>Please make sure the internal names ("tags") of files are using "camelCase"<ul>
<li>Example: for "@page documentationGuide Documentation Guide" "documentationGuide" is the name/tag used internally by doxygen. "Documentation Guide" is what shows up on the output documentation. </li> <li>Example: for "@page documentationGuide Documentation Guide" "documentationGuide" is the name/tag used internally by doxygen. "Documentation Guide" is what shows up on the output documentation.</li>
</ul> </ul>
</li> </li>
</ul> </ul>
<h2><a class="anchor" id="autotoc_md23"></a>
Adding Images</h2>
<p>Use this pattern/format: </p><div class="fragment"><div class="line">@image html &quot;Documentation Guide.assets/Funny-Cat-Hidden.jpg&quot;</div>
<div class="line">@cond EXCLUDED</div>
<div class="line">![img](Documentation Guide.assets/Funny-Cat-Hidden.jpg)</div>
<div class="line">@endcond</div>
</div><!-- fragment --><p>Which will output a single image that is both easily viewable in Doxygen, as well as Markdown viewers/editors. </p>
</div></div><!-- contents --> </div></div><!-- contents -->
</div><!-- PageDoc --> </div><!-- PageDoc -->
</div><!-- doc-content --> </div><!-- doc-content -->
<!-- start footer part --> <!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul> <ul>
<li class="footer">Generated on Wed Feb 3 2021 17:04:16 for 2020-2021 Sunseeker Telemetry and Lighting System 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> <li class="footer">Generated on Sat Feb 6 2021 19:02:29 for 2020-2021 Sunseeker Telemetry and Lighting System 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> </ul>
</div> </div>
</body> </body>

2
Documentation/html/files.html
View File

@@ -107,7 +107,7 @@ $(document).ready(function(){initNavTree('files.html',''); initResizable(); });
<!-- start footer part --> <!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul> <ul>
<li class="footer">Generated on Wed Feb 3 2021 17:04:16 for 2020-2021 Sunseeker Telemetry and Lighting System 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> <li class="footer">Generated on Sat Feb 6 2021 19:02:30 for 2020-2021 Sunseeker Telemetry and Lighting System 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> </ul>
</div> </div>
</body> </body>

2
Documentation/html/globals.html
View File

@@ -98,7 +98,7 @@ $(document).ready(function(){initNavTree('globals.html',''); initResizable(); })
<!-- start footer part --> <!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul> <ul>
<li class="footer">Generated on Wed Feb 3 2021 17:04:16 for 2020-2021 Sunseeker Telemetry and Lighting System 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> <li class="footer">Generated on Sat Feb 6 2021 19:02:30 for 2020-2021 Sunseeker Telemetry and Lighting System 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> </ul>
</div> </div>
</body> </body>

2
Documentation/html/globals_func.html
View File

@@ -98,7 +98,7 @@ $(document).ready(function(){initNavTree('globals_func.html',''); initResizable(
<!-- start footer part --> <!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul> <ul>
<li class="footer">Generated on Wed Feb 3 2021 17:04:16 for 2020-2021 Sunseeker Telemetry and Lighting System 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> <li class="footer">Generated on Sat Feb 6 2021 19:02:30 for 2020-2021 Sunseeker Telemetry and Lighting System 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> </ul>
</div> </div>
</body> </body>

2
Documentation/html/hardware.html
View File

@@ -118,7 +118,7 @@ Design Reminders</h1>
<!-- start footer part --> <!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul> <ul>
<li class="footer">Generated on Wed Feb 3 2021 17:04:16 for 2020-2021 Sunseeker Telemetry and Lighting System 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> <li class="footer">Generated on Sat Feb 6 2021 19:02:29 for 2020-2021 Sunseeker Telemetry and Lighting System 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> </ul>
</div> </div>
</body> </body>

2
Documentation/html/index.html
View File

@@ -140,7 +140,7 @@ TODO List</h1>
<!-- start footer part --> <!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul> <ul>
<li class="footer">Generated on Wed Feb 3 2021 17:04:16 for 2020-2021 Sunseeker Telemetry and Lighting System 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> <li class="footer">Generated on Sat Feb 6 2021 19:02:29 for 2020-2021 Sunseeker Telemetry and Lighting System 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> </ul>
</div> </div>
</body> </body>

2
Documentation/html/main_8c.html
View File

@@ -131,7 +131,7 @@ Functions</h2></td></tr>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul> <ul>
<li class="navelem"><a class="el" href="dir_4e9c05acfa2c3671b8618fcb95d57d96.html">Software</a></li><li class="navelem"><a class="el" href="dir_70428d3c5958c16802133545478a5cfb.html">Code Composer Studio Workspace</a></li><li class="navelem"><a class="el" href="dir_ef94255a62432ae865475b379d8bd501.html">SunseekerTelemetryAndLightingSystem</a></li><li class="navelem"><a class="el" href="main_8c.html">main.c</a></li> <li class="navelem"><a class="el" href="dir_4e9c05acfa2c3671b8618fcb95d57d96.html">Software</a></li><li class="navelem"><a class="el" href="dir_70428d3c5958c16802133545478a5cfb.html">Code Composer Studio Workspace</a></li><li class="navelem"><a class="el" href="dir_ef94255a62432ae865475b379d8bd501.html">SunseekerTelemetryAndLightingSystem</a></li><li class="navelem"><a class="el" href="main_8c.html">main.c</a></li>
<li class="footer">Generated on Wed Feb 3 2021 17:04:16 for 2020-2021 Sunseeker Telemetry and Lighting System 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> <li class="footer">Generated on Sat Feb 6 2021 19:02:29 for 2020-2021 Sunseeker Telemetry and Lighting System 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> </ul>
</div> </div>
</body> </body>

2
Documentation/html/main_8c_source.html
View File

@@ -108,7 +108,7 @@ $(document).ready(function(){initNavTree('main_8c_source.html',''); initResizabl
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul> <ul>
<li class="navelem"><a class="el" href="dir_4e9c05acfa2c3671b8618fcb95d57d96.html">Software</a></li><li class="navelem"><a class="el" href="dir_70428d3c5958c16802133545478a5cfb.html">Code Composer Studio Workspace</a></li><li class="navelem"><a class="el" href="dir_ef94255a62432ae865475b379d8bd501.html">SunseekerTelemetryAndLightingSystem</a></li><li class="navelem"><a class="el" href="main_8c.html">main.c</a></li> <li class="navelem"><a class="el" href="dir_4e9c05acfa2c3671b8618fcb95d57d96.html">Software</a></li><li class="navelem"><a class="el" href="dir_70428d3c5958c16802133545478a5cfb.html">Code Composer Studio Workspace</a></li><li class="navelem"><a class="el" href="dir_ef94255a62432ae865475b379d8bd501.html">SunseekerTelemetryAndLightingSystem</a></li><li class="navelem"><a class="el" href="main_8c.html">main.c</a></li>
<li class="footer">Generated on Wed Feb 3 2021 17:04:16 for 2020-2021 Sunseeker Telemetry and Lighting System 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> <li class="footer">Generated on Sat Feb 6 2021 19:02:29 for 2020-2021 Sunseeker Telemetry and Lighting System 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> </ul>
</div> </div>
</body> </body>

3
Documentation/html/navtreedata.js
View File

@@ -39,7 +39,8 @@ var NAVTREE =
[ "Doxygen", "documentation_guide.html#autotoc_md19", null ], [ "Doxygen", "documentation_guide.html#autotoc_md19", null ],
[ "Updating Documentation", "documentation_guide.html#autotoc_md20", null ], [ "Updating Documentation", "documentation_guide.html#autotoc_md20", null ],
[ "Important Notes", "documentation_guide.html#autotoc_md21", [ [ "Important Notes", "documentation_guide.html#autotoc_md21", [
[ "For Consistency", "documentation_guide.html#autotoc_md22", null ] [ "For Consistency", "documentation_guide.html#autotoc_md22", null ],
[ "Adding Images", "documentation_guide.html#autotoc_md23", null ]
] ] ] ]
] ], ] ],
[ "Files", "files.html", [ [ "Files", "files.html", [

1
Documentation/html/navtreeindex0.js
View File

@@ -24,6 +24,7 @@ var NAVTREEINDEX0 =
"documentation_guide.html#autotoc_md20":[3,1], "documentation_guide.html#autotoc_md20":[3,1],
"documentation_guide.html#autotoc_md21":[3,2], "documentation_guide.html#autotoc_md21":[3,2],
"documentation_guide.html#autotoc_md22":[3,2,0], "documentation_guide.html#autotoc_md22":[3,2,0],
"documentation_guide.html#autotoc_md23":[3,2,1],
"files.html":[4,0], "files.html":[4,0],
"globals.html":[4,1,0], "globals.html":[4,1,0],
"globals_func.html":[4,1,1], "globals_func.html":[4,1,1],

2
Documentation/html/pages.html
View File

@@ -106,7 +106,7 @@ $(document).ready(function(){initNavTree('pages.html',''); initResizable(); });
<!-- start footer part --> <!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul> <ul>
<li class="footer">Generated on Wed Feb 3 2021 17:04:16 for 2020-2021 Sunseeker Telemetry and Lighting System 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> <li class="footer">Generated on Sat Feb 6 2021 19:02:30 for 2020-2021 Sunseeker Telemetry and Lighting System 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> </ul>
</div> </div>
</body> </body>

2
Documentation/html/software.html
View File

@@ -98,7 +98,7 @@ $(document).ready(function(){initNavTree('software.html',''); initResizable(); }
<!-- start footer part --> <!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul> <ul>
<li class="footer">Generated on Wed Feb 3 2021 17:04:16 for 2020-2021 Sunseeker Telemetry and Lighting System 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> <li class="footer">Generated on Sat Feb 6 2021 19:02:29 for 2020-2021 Sunseeker Telemetry and Lighting System 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> </ul>
</div> </div>
</body> </body>

13
Documentation/latex/documentation_guide.tex
View File

@@ -17,4 +17,15 @@ You need to have installed the program from either the Git\+Hub page or website,
\begin{DoxyItemize} \begin{DoxyItemize}
\item Example\+: for \char`\"{}@page documentation\+Guide Documentation Guide\char`\"{} \char`\"{}documentation\+Guide\char`\"{} is the name/tag used internally by doxygen. \char`\"{}\+Documentation Guide\char`\"{} is what shows up on the output documentation. \item Example\+: for \char`\"{}@page documentation\+Guide Documentation Guide\char`\"{} \char`\"{}documentation\+Guide\char`\"{} is the name/tag used internally by doxygen. \char`\"{}\+Documentation Guide\char`\"{} is what shows up on the output documentation.
\end{DoxyItemize} \end{DoxyItemize}
\end{DoxyItemize} \end{DoxyItemize}\hypertarget{documentation_guide_autotoc_md23}{}\doxysubsection{Adding Images}\label{documentation_guide_autotoc_md23}
Use this pattern/format\+:
\begin{DoxyCode}{0}
\DoxyCodeLine{@image html "{}Documentation Guide.assets/Funny-\/Cat-\/Hidden.jpg"{}}
\DoxyCodeLine{@cond EXCLUDED}
\DoxyCodeLine{![img](Documentation Guide.assets/Funny-\/Cat-\/Hidden.jpg)}
\DoxyCodeLine{@endcond}
\end{DoxyCode}
Which will output a single image that is both easily viewable in Doxygen, as well as Markdown viewers/editors.

BIN
Meta/Documentation Guide.assets/Funny-Cat-Hidden.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 154 KiB

15
Meta/Documentation Guide.markdown
View File

@@ -33,3 +33,18 @@ You need to have installed the program from either the GitHub page or website, t
"documentationGuide" is the name/tag used internally by doxygen. "documentationGuide" is the name/tag used internally by doxygen.
"Documentation Guide" is what shows up on the output documentation. "Documentation Guide" is what shows up on the output documentation.
## Adding Images
Use this pattern/format:
@code
@image html "Documentation Guide.assets/Funny-Cat-Hidden.jpg"
@cond EXCLUDED
![img](Documentation Guide.assets/Funny-Cat-Hidden.jpg)
@endcond
@endcode
Which will output a single image that is both easily viewable in Doxygen, as well as Markdown viewers/editors.
@cond EXCLUDED
**Note: if you are reading this in a Markdown/text editor, do not include the '@code' and '@endcode' lines! Those are just to present it nicely for those reading in Doxygen pages. Please also switch to view the source code view if not already, that way you can see the code for the Markdown image.**
@endcond