Updating docs

include/api.h

@@ -41,9 +41,9 @@
 
 #define PROS_VERSION_MAJOR 4
 #define PROS_VERSION_MINOR 0
-#define PROS_VERSION_PATCH 6
-#define PROS_VERSION_STRING "4.0.6"
 
+#define PROS_VERSION_PATCH 7
+#define PROS_VERSION_STRING "4.0.7"
 
 #include "pros/adi.h"
 #include "pros/colors.h"

include/main.h

@@ -22,7 +22,7 @@
  *
  * For instance, E_CONTROLLER_MASTER has a shorter name: CONTROLLER_MASTER.
  * E_CONTROLLER_MASTER is pedantically correct within the PROS styleguide, but
- * not convienent for most student programmers.
+ * not convenient for most student programmers.
  */
 #define PROS_USE_SIMPLE_NAMES
 

include/pros/device.hpp

@@ -137,8 +137,48 @@ class Device {
 	 */
 	pros::DeviceType get_plugged_type() const;
 
+
+	/**
+	 * Gets the type of device on a given port.
+	 * 
+	 * This function uses the following values of errno when an error state is
+	 * reached:
+	 * EACCES - Mutex of port cannot be taken (access denied).
+	 * 
+	 * \param port The V5 port number from 1-21
+	 * 
+	 * \return The device type as an enum.
+	 *
+	 * \b Example
+ 	 * \code
+	 * #define DEVICE_PORT 1
+	 *
+	 * void opcontrol() {
+	 *   while (true) { 
+	 *     DeviceType dt = pros::Device::get_plugged_type(DEVICE_PORT);
+	 *     printf("device plugged type: {plugged type: %d}\n", dt);
+	 *     delay(20);
+	 *   }
+	 * }
+ 	 * \endcode
+	 */
 	static pros::DeviceType get_plugged_type(std::uint8_t port);
 
+	/**
+	 * Gets all devices of a given device type.
+	 * 
+	 * \param device_type The pros::DeviceType enum that matches the type of device desired.
+	 * 
+	 * \return A vector of Device objects for the given device type.
+	 *
+	 * \b Example
+ 	 * \code
+	 * void opcontrol() {
+	 *   std::vector<Device> motor_devices = pros::Device::get_all_devices(pros::DeviceType::motor);  // All Device objects are motors
+	 * }
+ 	 * \endcode
+	 */
+
 	static std::vector<Device> get_all_devices(pros::DeviceType device_type = pros::DeviceType::undefined);
 
 	protected:

include/pros/distance.hpp

@@ -12,7 +12,7 @@
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
- * 
+ *
  * \defgroup cpp-distance VEX Distance Sensor C++ API
  */
 
@@ -34,7 +34,7 @@ class Distance : public Device {
 	/**
 	 * \addtogroup cpp-distance
 	 *  @{
- 	*/
+	 */
 	public:
 	/**
 	 * Creates a Distance Sensor object for the given port.
@@ -58,9 +58,7 @@ class Distance : public Device {
 	 */
 	Distance(const std::uint8_t port);
 
-	Distance(const Device& device)
-		: Distance(device.get_port()) {};
-
+	Distance(const Device& device) : Distance(device.get_port()){};
 	/**
 	 * Get the currently measured distance from the sensor in mm
 	 *
@@ -75,9 +73,9 @@ class Distance : public Device {
 	 * \b Example
 	 * \code
 	 * #define DISTANCE_PORT 1
-	 * 
+	 *
 	 * void opcontrol() {
-		Distance distance(DISTANCE_PORT);
+	  Distance distance(DISTANCE_PORT);
 	 *   while (true) {
 	 *     printf("Distance confidence: %d\n", distance.get());
 	 *     delay(20);
@@ -87,8 +85,6 @@ class Distance : public Device {
 	 */
 	virtual std::int32_t get();
 
-	static std::vector<Distance> get_all_devices();
-
 	/**
 	 * Get the currently measured distance from the sensor in mm.
 	 * \note This function is identical to get().
@@ -104,9 +100,9 @@ class Distance : public Device {
 	 * \b Example
 	 * \code
 	 * #define DISTANCE_PORT 1
-	 * 
+	 *
 	 * void opcontrol() {
-		Distance distance(DISTANCE_PORT);
+	  Distance distance(DISTANCE_PORT);
 	 *   while (true) {
 	 *     printf("Distance confidence: %d\n", distance.get_distance());
 	 *     delay(20);
@@ -116,6 +112,21 @@ class Distance : public Device {
 	 */
 	virtual std::int32_t get_distance();
 
+	/**
+	 * Gets all distance sensors.
+	 *
+	 * \return A vector of Distance sensor objects.
+	 *
+	 * \b Example
+	 * \code
+	 * void opcontrol() {
+	 *   std::vector<Distance> distance_all = pros::Distance::get_all_devices();  // All distance sensors that are
+	 * connected
+	 * }
+	 * \endcode
+	 */
+	static std::vector<Distance> get_all_devices();
+
 	/**
 	 * Get the confidence in the distance reading
 	 *
@@ -134,9 +145,9 @@ class Distance : public Device {
 	 * \b Example
 	 * \code
 	 * #define DISTANCE_PORT 1
-	 * 
+	 *
 	 * void opcontrol() {
-		Distance distance(DISTANCE_PORT);
+	  Distance distance(DISTANCE_PORT);
 	 *   while (true) {
 	 *     printf("Distance confidence: %d\n", distance.get_confidence());
 	 *     delay(20);
@@ -164,9 +175,9 @@ class Distance : public Device {
 	 * \b Example
 	 * \code
 	 * #define DISTANCE_PORT 1
-	 * 
+	 *
 	 * void opcontrol() {
-		Distance distance(DISTANCE_PORT);
+	  Distance distance(DISTANCE_PORT);
 	 *   while (true) {
 	 *     printf("Distance confidence: %d\n", distance.get_object_size());
 	 *     delay(20);
@@ -186,10 +197,10 @@ class Distance : public Device {
 	 *
 	 * \return The velocity value or PROS_ERR if the operation failed, setting
 	 * errno.
-	 * 
+	 *
 	 * \b Example
 	 * \code
-	 * 
+	 *
 	 * void opcontrol() {
 	 *	Distance distance(DISTANCE_PORT);
 	 *   while (true) {
@@ -201,23 +212,36 @@ class Distance : public Device {
 	 */
 	virtual double get_object_velocity();
 
-    /**
-     * This is the overload for the << operator for printing to streams
-     *
-     * Prints in format(this below is all in one line with no new line):
-     * Distance [port: (port number), distance: (distance), confidence: (confidence),
-     * object size: (object size), object velocity: (object velocity)]
-     */
+	/**
+	 * This is the overload for the << operator for printing to streams
+	 *
+	 * Prints in format(this below is all in one line with no new line):
+	 * Distance [port: (port number), distance: (distance), confidence: (confidence),
+	 * object size: (object size), object velocity: (object velocity)]
+	 */
 	friend std::ostream& operator<<(std::ostream& os, pros::Distance& distance);
-  
+
 	private:
 	///@}
 };
 
 namespace literals {
+/**
+ * Constructs a Distance sensor object from a literal ending in _dist via calling the constructor
+ *
+ * \return a pros::Distance for the corresponding port
+ *
+ * \b Example
+ * \code
+ * using namespace pros::literals;
+ * void opcontrol() {
+ *	pros::Distance dist = 2_dist; //Makes an dist object on port 2
+ * }
+ * \endcode
+ */
 const pros::Distance operator"" _dist(const unsigned long long int d);
 }  // namespace literals
-}
+}  // namespace v5
 }  // namespace pros
 
 #endif

include/pros/gps.hpp

@@ -223,6 +223,19 @@ class Gps : public Device {
 	 */
 	virtual std::int32_t set_offset(double xOffset, double yOffset) const;
 
+	/**
+
+	 * Gets all GPS sensors.
+	 *
+	 * \return A vector of Gps sensor objects.
+	 *
+	 * \b Example
+	 * \code
+	 * void opcontrol() {
+	 *   std::vector<Gps> gps_all = pros::Gps::get_all_devices();  // All GPS sensors that are connected
+	 * }
+	 * \endcode
+	 */
 	static std::vector<Gps> get_all_devices();
 
 	/**

include/pros/imu.hpp

@@ -83,8 +83,8 @@ class Imu : public Device {
 	 * \endcode
 	 */
 
-	Imu(const std::uint8_t port) : Device(port, DeviceType::imu) {};
 
+	Imu(const std::uint8_t port) : Device(port, DeviceType::imu){};
 
 	Imu(const Device& device) : Imu(device.get_port()){};
 
@@ -190,6 +190,20 @@ class Imu : public Device {
 	 */
 	virtual std::int32_t set_data_rate(std::uint32_t rate) const;
 
+
+	/**
+	 * Gets all IMU sensors.
+	 * 
+	 * \return A vector of Imu sensor objects.
+	 *
+	 * \b Example
+ 	 * \code
+	 * void opcontrol() {
+	 *   std::vector<Imu> imu_all = pros::Imu::get_all_devices();  // All IMU sensors that are connected
+	 * }
+ 	 * \endcode
+	 */
+
 	static std::vector<Imu> get_all_devices();
 
 	/**
@@ -1040,6 +1054,19 @@ class Imu : public Device {
 };
 
 namespace literals {
+/**
+ * Constructs a Imu from a literal ending in _imu via calling the constructor
+ *
+ * \return a pros::Imu for the corresponding port
+ *
+ * \b Example
+ * \code
+ * using namespace pros::literals;
+ * void opcontrol() {
+ *	pros::Imu imu = 2_imu; //Makes an IMU object on port 2
+ * }
+ * \endcode
+ */
 const pros::Imu operator"" _imu(const unsigned long long int i);
 }  // namespace literals