From a60a8a50cf4af2881d12a98c515dd8b6714e9a46 Mon Sep 17 00:00:00 2001 From: William Miceli Date: Sat, 30 Jan 2021 17:37:32 -0500 Subject: [PATCH] Doxygen Update --- Documentation/html/_9_hardware_8markdown.html | 2 +- .../html/_9_references_8markdown.html | 98 ++++++++++++++++ Documentation/html/_9_software_8markdown.html | 2 +- .../_device_01_specifications_8markdown.html | 2 +- .../_documentation_01_guide_8markdown.html | 2 +- .../html/_layout_01_planning_8markdown.html | 2 +- .../html/_r_e_a_d_m_e_8markdown.html | 2 +- Documentation/html/device_specifications.html | 22 ++-- .../dir_465c8a410b787ccece2cc89dfe6b85b1.html | 98 ++++++++++++++++ .../dir_4e9c05acfa2c3671b8618fcb95d57d96.html | 2 +- .../dir_6cc751a9e685a986d41d35de353de328.html | 2 +- .../dir_6cc751a9e685a986d41d35de353de328.js | 22 ++-- .../dir_70428d3c5958c16802133545478a5cfb.html | 2 +- .../dir_7795a02a4813dcd036f04e5f7854f185.html | 2 +- .../dir_ef94255a62432ae865475b379d8bd501.html | 2 +- Documentation/html/documentation_guide.html | 15 +-- Documentation/html/files.html | 11 +- Documentation/html/files_dup.js | 1 + Documentation/html/globals.html | 2 +- Documentation/html/globals_func.html | 2 +- Documentation/html/hardware.html | 18 ++- Documentation/html/hardware.js | 1 + Documentation/html/index.html | 10 +- Documentation/html/layout_planning.html | 4 +- Documentation/html/main_8c.html | 2 +- Documentation/html/main_8c_source.html | 2 +- Documentation/html/navtreedata.js | 19 +-- Documentation/html/navtreeindex0.js | 68 +++++------ Documentation/html/pages.html | 3 +- Documentation/html/references.html | 108 ++++++++++++++++++ Documentation/html/search/all_0.js | 3 +- Documentation/html/search/all_1.js | 8 +- Documentation/html/search/all_2.js | 2 +- Documentation/html/search/all_3.js | 4 +- Documentation/html/search/all_4.js | 4 +- Documentation/html/search/all_5.js | 3 +- Documentation/html/search/all_6.js | 2 +- Documentation/html/search/files_0.js | 5 +- Documentation/html/search/files_1.js | 4 +- Documentation/html/search/files_2.js | 2 +- Documentation/html/search/files_3.js | 2 +- Documentation/html/search/files_4.js | 2 +- Documentation/html/search/functions_0.js | 2 +- Documentation/html/search/pages_0.js | 4 +- Documentation/html/search/pages_1.js | 2 +- Documentation/html/search/pages_2.js | 2 +- Documentation/html/search/pages_3.js | 2 +- Documentation/html/search/pages_4.html | 37 ++++++ Documentation/html/search/pages_4.js | 4 + Documentation/html/search/searchdata.js | 2 +- Documentation/html/software.html | 2 +- .../latex/_9_references_8markdown.tex | 2 + .../dir_465c8a410b787ccece2cc89dfe6b85b1.tex | 2 + Documentation/latex/documentation_guide.tex | 13 ++- Documentation/latex/hardware.tex | 37 ++++-- Documentation/latex/index.tex | 8 +- Documentation/latex/references.tex | 13 +++ Documentation/latex/refman.tex | 5 + 58 files changed, 558 insertions(+), 148 deletions(-) create mode 100644 Documentation/html/_9_references_8markdown.html create mode 100644 Documentation/html/dir_465c8a410b787ccece2cc89dfe6b85b1.html create mode 100644 Documentation/html/references.html create mode 100644 Documentation/html/search/pages_4.html create mode 100644 Documentation/html/search/pages_4.js create mode 100644 Documentation/latex/_9_references_8markdown.tex create mode 100644 Documentation/latex/dir_465c8a410b787ccece2cc89dfe6b85b1.tex create mode 100644 Documentation/latex/references.tex diff --git a/Documentation/html/_9_hardware_8markdown.html b/Documentation/html/_9_hardware_8markdown.html index ed876f4..800fb6b 100644 --- a/Documentation/html/_9_hardware_8markdown.html +++ b/Documentation/html/_9_hardware_8markdown.html @@ -91,7 +91,7 @@ $(document).ready(function(){initNavTree('_9_hardware_8markdown.html',''); initR diff --git a/Documentation/html/_9_references_8markdown.html b/Documentation/html/_9_references_8markdown.html new file mode 100644 index 0000000..96b29b4 --- /dev/null +++ b/Documentation/html/_9_references_8markdown.html @@ -0,0 +1,98 @@ + + + + + + + +2020-2021 Sunseeker Telemetry and Lighting System: References/!References.markdown File Reference + + + + + + + + + + + + + +
+
+ + + + + + +
+
2020-2021 Sunseeker Telemetry and Lighting System +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
References/!References.markdown File Reference
+
+
+
+
+ + + + diff --git a/Documentation/html/_9_software_8markdown.html b/Documentation/html/_9_software_8markdown.html index 0beb8a2..69c52c8 100644 --- a/Documentation/html/_9_software_8markdown.html +++ b/Documentation/html/_9_software_8markdown.html @@ -91,7 +91,7 @@ $(document).ready(function(){initNavTree('_9_software_8markdown.html',''); initR diff --git a/Documentation/html/_device_01_specifications_8markdown.html b/Documentation/html/_device_01_specifications_8markdown.html index df64c6c..7ced232 100644 --- a/Documentation/html/_device_01_specifications_8markdown.html +++ b/Documentation/html/_device_01_specifications_8markdown.html @@ -91,7 +91,7 @@ $(document).ready(function(){initNavTree('_device_01_specifications_8markdown.ht diff --git a/Documentation/html/_documentation_01_guide_8markdown.html b/Documentation/html/_documentation_01_guide_8markdown.html index 518f1f1..49cb275 100644 --- a/Documentation/html/_documentation_01_guide_8markdown.html +++ b/Documentation/html/_documentation_01_guide_8markdown.html @@ -91,7 +91,7 @@ $(document).ready(function(){initNavTree('_documentation_01_guide_8markdown.html diff --git a/Documentation/html/_layout_01_planning_8markdown.html b/Documentation/html/_layout_01_planning_8markdown.html index 9ba69c7..3ff8f0d 100644 --- a/Documentation/html/_layout_01_planning_8markdown.html +++ b/Documentation/html/_layout_01_planning_8markdown.html @@ -91,7 +91,7 @@ $(document).ready(function(){initNavTree('_layout_01_planning_8markdown.html','' diff --git a/Documentation/html/_r_e_a_d_m_e_8markdown.html b/Documentation/html/_r_e_a_d_m_e_8markdown.html index 300cdc9..32d262a 100644 --- a/Documentation/html/_r_e_a_d_m_e_8markdown.html +++ b/Documentation/html/_r_e_a_d_m_e_8markdown.html @@ -91,7 +91,7 @@ $(document).ready(function(){initNavTree('_r_e_a_d_m_e_8markdown.html',''); init diff --git a/Documentation/html/device_specifications.html b/Documentation/html/device_specifications.html index 3c6cb49..584957d 100644 --- a/Documentation/html/device_specifications.html +++ b/Documentation/html/device_specifications.html @@ -85,7 +85,7 @@ $(document).ready(function(){initNavTree('device_specifications.html',''); initR
Device Specifications
-

+

Microcontroller: Texas Instruments MSP430F5438AIPZR

  • 1.8 V to 3.6 V Supply Voltage
    • @@ -110,7 +110,7 @@ Microcontroller: Texas Instruments MSP430F5438AIPZR

-

+

Real-Time Clock/Calendar: Microchip Technology ‎MCP7940MT-I/SN

  • 1.8 V to 5.5 V Supply Voltage
    • @@ -122,7 +122,7 @@ Real-Time Clock/Calendar: Microchip Technology ‎MCP7940MT-I/SN
-

+

Bluetooth/Wi-Fi: Espressif Systems ESP32-WROVER-IE (8MB)

  • 3.0 V to 3.6 V Supply Voltage
    • @@ -133,7 +133,7 @@ Bluetooth/Wi-Fi: Espressif Systems ESP32-WROVER-IE (8MB)
-

+

GPS Receiver: Maxim Integrated ‎MAX2771ETI+T

  • 2.7 V to 3.3 V Supply Voltage
    • @@ -142,7 +142,7 @@ GPS Receiver: Maxim Integrated ‎MAX2771ETI+T
-

+

CANbus Controller: Microchip Technology MCP2515T-I/SO

  • 2.7 V to 5.5 V Supply Voltage
    • @@ -154,13 +154,13 @@ CANbus Controller: Microchip Technology MCP2515T-I/SO
-

+

CAN Bus Transceiver: ‎Microchip Technology MCP2542FD-H/SN

  • 4.5 V to 5.5 V Supply Voltage
  • Used directly with CANbus Controller
-

+

SD Card (Generic)

  • 2.7 V to 3.6 V Supply Voltage
    • @@ -169,14 +169,14 @@ SD Card (Generic)
-

+

USB to UART Bridge: FTDI ‎‎FT260Q-T

  • We will use a "Bus-Powered Configuration", requiring the host device to supply power, that way we don't have to.
-

-RS-232 Transceiver: Texas Instruments GD75232PWR

+RS-232 Transceiver: Texas Instruments GD75232PWR

+

Inertial Measurement Unit: TDK InvenSense ICM-20600

  • 1.71 V to 3.45 V Supply Voltage
    • @@ -199,7 +199,7 @@ Inertial Measurement Unit: TDK InvenSense ICM-20600 diff --git a/Documentation/html/dir_465c8a410b787ccece2cc89dfe6b85b1.html b/Documentation/html/dir_465c8a410b787ccece2cc89dfe6b85b1.html new file mode 100644 index 0000000..b270a8e --- /dev/null +++ b/Documentation/html/dir_465c8a410b787ccece2cc89dfe6b85b1.html @@ -0,0 +1,98 @@ + + + + + + + +2020-2021 Sunseeker Telemetry and Lighting System: References Directory Reference + + + + + + + + + + + + + +
    +
    + + + + + + +
    +
    2020-2021 Sunseeker Telemetry and Lighting System +
    +
    +
    + + + + + + + +
    +
    + +
    +
    +
    + +
    + +
    +
    + + +
    + +
    + +
    +
    +
    References Directory Reference
    +
    +
    +
    +
    + + + + diff --git a/Documentation/html/dir_4e9c05acfa2c3671b8618fcb95d57d96.html b/Documentation/html/dir_4e9c05acfa2c3671b8618fcb95d57d96.html index 1206dfc..ecfbf13 100644 --- a/Documentation/html/dir_4e9c05acfa2c3671b8618fcb95d57d96.html +++ b/Documentation/html/dir_4e9c05acfa2c3671b8618fcb95d57d96.html @@ -97,7 +97,7 @@ Directories diff --git a/Documentation/html/dir_6cc751a9e685a986d41d35de353de328.html b/Documentation/html/dir_6cc751a9e685a986d41d35de353de328.html index f60e0e2..7e44cc2 100644 --- a/Documentation/html/dir_6cc751a9e685a986d41d35de353de328.html +++ b/Documentation/html/dir_6cc751a9e685a986d41d35de353de328.html @@ -91,7 +91,7 @@ $(document).ready(function(){initNavTree('dir_6cc751a9e685a986d41d35de353de328.h diff --git a/Documentation/html/dir_6cc751a9e685a986d41d35de353de328.js b/Documentation/html/dir_6cc751a9e685a986d41d35de353de328.js index 9112569..4ae6145 100644 --- a/Documentation/html/dir_6cc751a9e685a986d41d35de353de328.js +++ b/Documentation/html/dir_6cc751a9e685a986d41d35de353de328.js @@ -1,14 +1,14 @@ var dir_6cc751a9e685a986d41d35de353de328 = [ - [ "Microcontroller: Texas Instruments MSP430F5438AIPZR", "device_specifications.html#autotoc_md1", null ], - [ "Real-Time Clock/Calendar: Microchip Technology ‎MCP7940MT-I/SN", "device_specifications.html#autotoc_md2", null ], - [ "Bluetooth/Wi-Fi: Espressif Systems ESP32-WROVER-IE (8MB)", "device_specifications.html#autotoc_md3", null ], - [ "GPS Receiver: Maxim Integrated ‎MAX2771ETI+T", "device_specifications.html#autotoc_md4", null ], - [ "CANbus Controller: Microchip Technology MCP2515T-I/SO", "device_specifications.html#autotoc_md5", null ], - [ "CAN Bus Transceiver: ‎Microchip Technology MCP2542FD-H/SN", "device_specifications.html#autotoc_md6", null ], - [ "SD Card (Generic)", "device_specifications.html#autotoc_md7", null ], - [ "USB to UART Bridge: FTDI ‎‎FT260Q-T", "device_specifications.html#autotoc_md8", null ], - [ "RS-232 Transceiver: Texas Instruments GD75232PWR", "device_specifications.html#autotoc_md9", null ], - [ "Inertial Measurement Unit: TDK InvenSense ICM-20600", "device_specifications.html#autotoc_md10", null ], - [ "Microcontroller", "layout_planning.html#autotoc_md11", null ] + [ "Microcontroller: Texas Instruments MSP430F5438AIPZR", "device_specifications.html#autotoc_md2", null ], + [ "Real-Time Clock/Calendar: Microchip Technology ‎MCP7940MT-I/SN", "device_specifications.html#autotoc_md3", null ], + [ "Bluetooth/Wi-Fi: Espressif Systems ESP32-WROVER-IE (8MB)", "device_specifications.html#autotoc_md4", null ], + [ "GPS Receiver: Maxim Integrated ‎MAX2771ETI+T", "device_specifications.html#autotoc_md5", null ], + [ "CANbus Controller: Microchip Technology MCP2515T-I/SO", "device_specifications.html#autotoc_md6", null ], + [ "CAN Bus Transceiver: ‎Microchip Technology MCP2542FD-H/SN", "device_specifications.html#autotoc_md7", null ], + [ "SD Card (Generic)", "device_specifications.html#autotoc_md8", null ], + [ "USB to UART Bridge: FTDI ‎‎FT260Q-T", "device_specifications.html#autotoc_md9", null ], + [ "RS-232 Transceiver: Texas Instruments GD75232PWR", "device_specifications.html#autotoc_md10", null ], + [ "Inertial Measurement Unit: TDK InvenSense ICM-20600", "device_specifications.html#autotoc_md11", null ], + [ "Microcontroller", "layout_planning.html#autotoc_md12", null ] ]; \ No newline at end of file diff --git a/Documentation/html/dir_70428d3c5958c16802133545478a5cfb.html b/Documentation/html/dir_70428d3c5958c16802133545478a5cfb.html index abd62ba..058531c 100644 --- a/Documentation/html/dir_70428d3c5958c16802133545478a5cfb.html +++ b/Documentation/html/dir_70428d3c5958c16802133545478a5cfb.html @@ -97,7 +97,7 @@ Directories diff --git a/Documentation/html/dir_7795a02a4813dcd036f04e5f7854f185.html b/Documentation/html/dir_7795a02a4813dcd036f04e5f7854f185.html index 26474ef..20b97bd 100644 --- a/Documentation/html/dir_7795a02a4813dcd036f04e5f7854f185.html +++ b/Documentation/html/dir_7795a02a4813dcd036f04e5f7854f185.html @@ -91,7 +91,7 @@ $(document).ready(function(){initNavTree('dir_7795a02a4813dcd036f04e5f7854f185.h diff --git a/Documentation/html/dir_ef94255a62432ae865475b379d8bd501.html b/Documentation/html/dir_ef94255a62432ae865475b379d8bd501.html index 9fb02f6..f5b03b3 100644 --- a/Documentation/html/dir_ef94255a62432ae865475b379d8bd501.html +++ b/Documentation/html/dir_ef94255a62432ae865475b379d8bd501.html @@ -97,7 +97,7 @@ Files diff --git a/Documentation/html/documentation_guide.html b/Documentation/html/documentation_guide.html index fdf04a0..3627539 100644 --- a/Documentation/html/documentation_guide.html +++ b/Documentation/html/documentation_guide.html @@ -85,25 +85,26 @@ $(document).ready(function(){initNavTree('documentation_guide.html',''); initRes
    Documentation Guide
-

+

Doxygen

The program called "doxygen" (GitHub Page and Website) 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.

It simply uses a small configuration file at the root of the project /Doxyfile to store some settings, and the rest is through mainly Markdown files (.md or .markdown) and source code files.

It is setup (as of writing this) that someone can simply open the /Doxyfile in the GUI Wizard, click on the "Run" tab, then "Run doxygen", and everything will be updated... that's it.

-

+

Updating Documentation

You need to have installed the program from either the GitHub page or website, then simply open the /Doxyfile within the GUI frontend or "Wizard".

-

+

Important Notes

  • Make sure that the /Doxyfile stays where it's at! It should be kept at the root directory (just to keep things simple)
  • Make sure you use RELATIVE paths when changing configurations, or else when someone else tries running the /Doxyfile, they'll have to re-do all of them in order for it to start functioning again.
    • +
  • DO NOT put any files into the /Documentation folder manually, as they WILL BE DELETED when doxygen is run.
-

+

For Consistency

    -
  • Please make sure the internal names of files are using "camelCase"
      -
    • Example: for "@page documentationGuide Documentation Guide" "documentationGuide" is the name used internally by doxygen. "Documentation Guide" is what shows up on the output documentation.
      • +
    • Please make sure the internal names ("tags") of files are using "camelCase"
        +
      • 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.
    @@ -113,7 +114,7 @@ For Consistency

diff --git a/Documentation/html/files.html b/Documentation/html/files.html index d91516c..a5966f2 100644 --- a/Documentation/html/files.html +++ b/Documentation/html/files.html @@ -89,10 +89,11 @@ $(document).ready(function(){initNavTree('files.html',''); initResizable(); });
[detail level 1234]
- - - - + + + + +
 Hardware
 Meta
 ▼ Software
 ▼ Code Composer Studio Workspace
 ▼ SunseekerTelemetryAndLightingSystem
 main.c
 References
 ▼ Software
 ▼ Code Composer Studio Workspace
 ▼ SunseekerTelemetryAndLightingSystem
 main.c
@@ -100,7 +101,7 @@ $(document).ready(function(){initNavTree('files.html',''); initResizable(); }); diff --git a/Documentation/html/files_dup.js b/Documentation/html/files_dup.js index 5b0d271..a26e788 100644 --- a/Documentation/html/files_dup.js +++ b/Documentation/html/files_dup.js @@ -2,5 +2,6 @@ var files_dup = [ [ "Hardware", "dir_6cc751a9e685a986d41d35de353de328.html", "dir_6cc751a9e685a986d41d35de353de328" ], [ "Meta", "dir_7795a02a4813dcd036f04e5f7854f185.html", null ], + [ "References", "dir_465c8a410b787ccece2cc89dfe6b85b1.html", null ], [ "Software", "dir_4e9c05acfa2c3671b8618fcb95d57d96.html", "dir_4e9c05acfa2c3671b8618fcb95d57d96" ] ]; \ No newline at end of file diff --git a/Documentation/html/globals.html b/Documentation/html/globals.html index 4021bd4..b12f78a 100644 --- a/Documentation/html/globals.html +++ b/Documentation/html/globals.html @@ -91,7 +91,7 @@ $(document).ready(function(){initNavTree('globals.html',''); initResizable(); }) diff --git a/Documentation/html/globals_func.html b/Documentation/html/globals_func.html index bb77d7d..b956ce7 100644 --- a/Documentation/html/globals_func.html +++ b/Documentation/html/globals_func.html @@ -91,7 +91,7 @@ $(document).ready(function(){initNavTree('globals_func.html',''); initResizable( diff --git a/Documentation/html/hardware.html b/Documentation/html/hardware.html index fe29278..25ccb8a 100644 --- a/Documentation/html/hardware.html +++ b/Documentation/html/hardware.html @@ -91,14 +91,28 @@ $(document).ready(function(){initNavTree('hardware.html',''); initResizable(); }
  • Layout Planning
    • - +

    +Design Reminders

    + + diff --git a/Documentation/html/hardware.js b/Documentation/html/hardware.js index 34784ab..01726fc 100644 --- a/Documentation/html/hardware.js +++ b/Documentation/html/hardware.js @@ -1,5 +1,6 @@ var hardware = [ + [ "Design Reminders", "hardware.html#autotoc_md1", null ], [ "Device Specifications", "device_specifications.html", null ], [ "Layout Planning", "layout_planning.html", null ] ]; \ No newline at end of file diff --git a/Documentation/html/index.html b/Documentation/html/index.html index 5bb2783..bb3f534 100644 --- a/Documentation/html/index.html +++ b/Documentation/html/index.html @@ -91,14 +91,14 @@ $(document).ready(function(){initNavTree('index.html',''); initResizable(); });
  • Software
    • -

    +

    About

    What this project is about (TODO)

    -

    +

    Documentation

    For Documentation, we will use "doxygen" to easily create documentation pages for the project. This will be accessible in a variety of means, but primarily through HTML pages accessible through a browser, covering all aspects of the project.

    More information here: Documentation Guide

    -

    +

    Tips from Dr. Bazuin

    -

    +

    Tips from Dr. Gomez