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

Updated Docs

Browse Source
This commit is contained in:
William Miceli
2021-02-02 00:51:29 -05:00
parent a9acafed53
commit 8d69e473b5
48 changed files with 541 additions and 189 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
Documentation/html/documentation_guide.html
View File

@@ -85,22 +85,22 @@ $(document).ready(function(){initNavTree('documentation_guide.html',''); initRes
<div class="title">Documentation Guide </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><h1><a class="anchor" id="autotoc_md18"></a>
<div class="textblock"><h1><a class="anchor" id="autotoc_md20"></a>
Doxygen</h1>
<p>The program called "doxygen" (<a href="https://github.com/doxygen/doxygen">GitHub Page</a> and <a href="https://www.doxygen.nl/">Website</a>) is what we're using to document our project and try to make things a bit simpler/easier not only for us, but also future projects or people looking at what we've done.</p>
<p>It simply uses a small configuration file at the root of the project <code>/Doxyfile</code> to store some settings, and the rest is through mainly Markdown files (<code>.md</code> or <code>.markdown</code>) and source code files.</p>
<p>It is setup (as of writing this) that someone can simply open the <code>/Doxyfile</code> in the GUI Wizard, click on the "Run" tab, then "Run doxygen", and everything will be updated... that's it.</p>
<h1><a class="anchor" id="autotoc_md19"></a>
<h1><a class="anchor" id="autotoc_md21"></a>
Updating Documentation</h1>
<p>You need to have installed the program from either the GitHub page or website, then simply open the <code>/Doxyfile</code> within the GUI frontend or "Wizard".</p>
<h1><a class="anchor" id="autotoc_md20"></a>
<h1><a class="anchor" id="autotoc_md22"></a>
Important Notes</h1>
<ul>
<li>Make sure that the <code>/Doxyfile</code> stays where it's at! It should be kept at the root directory (just to keep things simple)</li>
<li>Make sure you use RELATIVE paths when changing configurations, or else when someone else tries running the <code>/Doxyfile</code>, they'll have to re-do all of them in order for it to start functioning again.</li>
<li><b>DO NOT</b> put any files into the <code>/Documentation</code> folder manually, as they <b>WILL BE DELETED</b> when doxygen is run.</li>
</ul>
<h2><a class="anchor" id="autotoc_md21"></a>
<h2><a class="anchor" id="autotoc_md23"></a>
For Consistency</h2>
<ul>
<li>Please make sure the internal names ("tags") of files are using "camelCase"<ul>
@@ -114,7 +114,7 @@ For Consistency</h2>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Sat Jan 30 2021 17:37:13 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 Tue Feb 2 2021 00:44:35 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>
</div>
</body>