🔼 PROS 4: Doxygen Documentation Enhancements (#565)

* Start of work on motors docs

* Add descriptions for color files.

* Error.h

* gps.hpp done

* Gps.h done

* More motors docs

* Motor docs and fixed the build

* added changes to device.hpp, distance.hpp and
imu.hpp

* Revert "added changes to device.hpp, distance.hpp and"

This reverts commit 380a2de.

* Do the link files

* attempt to fix issue with ADI

* Fix ADI Doc value

* Remove accidental addition of extra bracket

* AbstractMotor work

* attempt to refix something

* yep looks like that was the culprit

* Add it back because it was breaking stuff

* The serial files

* Optical cpp examples

* Get rid of legacy api file (nobody uses PROS 2 API anymore)

* Update documentation for the llemu api

* Update rtos.h

* Attempt to fix adi doc bracketing

* Update rtos.h

* Fix up formatting on rtos.h

* try something really stupid

* Finished functions in motors.h

* progress on motors.hpp

* Update adi bracketting

* Fix adi.h bracketing again

* Comment brackets in rtos.h

* Try removing \enum and \typedef to see if that breaks m.css

* Try removing \def

* Try some more things to fix CI

* Strip name and group commands to see if that lets the CI get further

* More more motors.hpp work

* Update rtos.h

* More rtos.h updates

* abstract motor work

* rotation.h and rotation.hpp documentation

* Fixes to code examples.

* do some of the _all functions

* more stuff

* imu_set_euler

* MOTORS.HPP DONE

* added example for device.h

* fix typo

* added example for device.hpp

* fix issue

* fix formatting

* fix and add example in distance.h

* WIP on rtos.hpp

* ext_adi.h file

* fix typo in distance.h

* motors and motor group fixes

* Trying to fix motor linking

* Wip in rtos

* update example in device.hpp

* updated device.hpp examples

* updated distance.hpp examples

* fix typo in device.h

* fix typo in device.hpp

* Vision c++ header docs

* Update motors

* docs for mics, screen and abstract_motor(enum)

* Fix up device file, apix.h work

* added example for constructors in device.hpp and
distance.hpp

* imu.hpp function examples

* Small edit for imu.hpp function examples

* Added header for imu.hpp constructor

* Small edit for imu.hpp constructor header

* Remove links

* Fix up color and device files

* Finish rtos.h and rtos.hpp

* Fix cpp-link

* Fixes to motors docs

* Rotation.hpp docs updates

* Reverse Flag param in Rotation constructor

* Formatting fixes

* Fix motor groups and fix colors

* fixed file for motor group

* Fix bracketing

* Fix MG docs

* Remove PROS 2 references, fix up readmes

* Another fix

* Most of the work done for motor groups

* Fix missing end codes

* Almost done

* FINISHED MOTOR GROUPS

* added namespace for screen.hpp

* Update version

---------

Co-authored-by: Noam987 <[email protected]>
Co-authored-by: Richard Stump <[email protected]>
Co-authored-by: Aaryan Gautam <[email protected]>
Co-authored-by: Andrew Lu <[email protected]>
Co-authored-by: aberiggs <[email protected]>
Co-authored-by: Grace Lu <[email protected]>
Co-authored-by: AnnZi <[email protected]>

.github/CONTRIBUTING.md

@@ -7,7 +7,7 @@
   purduesigbots maintains four repositories related to PROS:
   - [purduesigbots/pros](https://github.com/purduesigbots/pros): the repository containing the source code for the kernel the user-facing API. Issues should be opened here if they affect the code you write (e.g., "I would like to be able to do X with PROS," or "when I call <PROS function> X doesn't work as I expect")
   - [purduesigbots/pros-cli](https://github.com/purduesigbots/pros-cli): the repository containing the source code for the command line interface (CLI). Issues should be opened here if they concern the PROS CLI (e.g., problems with commands like `pros make`), as well as project creation and management.
-  - [purduesigbots/pros-atom](https://github.com/purduesigbots/pros-atom): the repository containing the source code for the Atom package. Issues should be opened here if they concern the coding experience within Atom (e.g., "there is no button to do X," or "the linter is spamming my interface with errors").
+  - [purduesigbots/pros-atom](https://github.com/purduesigbots/pros-vsc): the repository containing the source code for the VSCode extension. Issues should be opened here if they concern the coding experience within VSCode (e.g., "there is no button to do X," or "the linter is spamming my interface with errors").
   - [purduesigbots/pros-docs](https://github.com/purduesigbots/pros-docs): the repository containing the source code for [our documentation website](https://pros.cs.purdue.edu). Issues should be opened here if they concern available documentation (e.g., "there is not guide on using <PROS feature>," or "the documentation says to do X, but only Y works")
 - **Verify the bug lies in PROS.** We receive quite a few reports that are due to bugs in user code, not the kernel.
 - Ensure the bug wasn't already reported by searching GitHub [issues](https://github.com/purduesigbots/pros/issues)

README.md

@@ -15,13 +15,16 @@ You can develop code on Windows, OS X, or Linux. Code is compiled using GCC and
 
 The PROS team develops a plugin for Atom to making developing projects in PROS the best possible experience. The highly customizable editor designed for the 21st century enables students to learn how to code in a modern environment.
 
+### What'st hte difference between PROS 4 and 3?
+PROS 4 is a Kernel upgrade from PROS 4 to both decrease the size of the base Kernel, and provide utilities such as the base device class and liblvgl that makes it easier for both users and library writers to customize their PROS projects. This version also moves all documentation to a doxygen site rather than a Sphinx documentation page. 
+
 ### What's the difference between PROS 2 and PROS 3?
 PROS 2 refers to the kernel that runs on the [VEX Arm Cortex-based Microcontroller](https://www.vexrobotics.com/276-2194.html). The source for this kernel is still available on the `cortex-master` branch. The future development for this version of the PROS kernel will be focused on maintenance and critical bugfixes.
 
 PROS 3 refers to the kernel that runs on the [VEX V5](https://www.vexrobotics.com/vexedr/v5) microcontroller platform. The majority of our development focus will be on this version of the PROS kernel.
 
 ### Does PROS support C++?
-- PROS 3.x (V5) officially supports C++. We're still working on enabling all of the features of C++ (particularly in the I/O area).
+- PROS 3.x and 4.x (V5) officially supports C++. We're still working on enabling all of the features of C++ (particularly in the I/O area).
 - PROS 2.x (Cortex) does not officially support C++. Some users have found ways around this, but be warned: we will not be able to help if you run into issues doing this.
 
 ### Cool, how do I get it?
@@ -47,5 +50,5 @@ We maintain GitHub repositories for the three major components of the PROS ecosy
 
 If you find a problem with our documentation or tutorials, we have a repository for that, too, at [purduesigbots/pros-docs](https://github.com/purduesigbots/pros-docs).
 
-### Hey! Why can't I build the PROS 3 kernel?
-The PROS 3 kernel depends on VEX's proprietary Software Development Kit (SDK), which is not publicly available.
+### Hey! Why can't I build the PROS kernel?
+The PROS kernel depends on VEX's proprietary Software Development Kit (SDK), which is not publicly available.

STYLEGUIDE.md

@@ -43,9 +43,6 @@ These should be placed at the very start of a file.
  * in the file contains and a general description of what they do (no specifics,
  * but they should all have something in common anyway).
  *
- * Visit https://pros.cs.purdue.edu/v5/tutorials/topical/filename.html to learn
- * more.
- *
  * This file should not be modified by users, since it gets replaced whenever
  * a kernel upgrade occurs.
  *

include/main.h

@@ -40,7 +40,6 @@
  * You should add more #includes here
  */
 //#include "okapi/api.hpp"
-//#include "pros/api_legacy.h"
 
 /**
  * If you find doing pros::Motor() to be tedious and you'd prefer just to do