From 1461d03070e7cb1b70b14090a528e43b310b21df Mon Sep 17 00:00:00 2001 From: Kunwar Sahni Date: Tue, 27 Oct 2020 21:01:30 -0400 Subject: [PATCH] Editing comments --- include/pros/optical.h | 9 ++++----- include/pros/optical.hpp | 6 ++++-- 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/include/pros/optical.h b/include/pros/optical.h index e0db281b2..ea4cb1c0e 100644 --- a/include/pros/optical.h +++ b/include/pros/optical.h @@ -134,7 +134,7 @@ double optical_get_brightness(uint8_t port); int32_t optical_get_proximity(uint8_t port); /** - * Set the pwm value of the White LED on the sensor + * Set the pwm value of the White LED * * value that ranges from 0 to 100 * @@ -151,9 +151,8 @@ int32_t optical_get_proximity(uint8_t port); int32_t optical_set_led_pwm(uint8_t port, uint8_t value); /** - * Get the pwm value of the White LED on the sensor + * Get the pwm value of the White LED * - * value that ranges from 0 to 100 * * This function uses the following values of errno when an error state is * reached: @@ -162,8 +161,8 @@ int32_t optical_set_led_pwm(uint8_t port, uint8_t value); * * \param port * The V5 Optical Sensor port number from 1-21 - * \return LED pwm value if the operation was successful or PROS_ERR if - * the operation failed, setting errno. + * \return LED pwm value that ranges from 0 to 100 if the operation was + * successful or PROS_ERR if the operation failed, setting errno. */ int32_t optical_get_led_pwm(uint8_t port); diff --git a/include/pros/optical.hpp b/include/pros/optical.hpp index 22d4bf54e..4b3c39da4 100644 --- a/include/pros/optical.hpp +++ b/include/pros/optical.hpp @@ -201,7 +201,8 @@ class Optical { * ENXIO - The given value is not within the range of V5 ports (1-21). * ENODEV - The port cannot be configured as an Optical Sensor * - * \return The Error code encountered + * \return 1 if the operation is successful or PROS_ERR if the operation failed, + * setting errno. */ virtual std::int32_t enable_gesture(); @@ -213,7 +214,8 @@ class Optical { * ENXIO - The given value is not within the range of V5 ports (1-21). * ENODEV - The port cannot be configured as an Optical Sensor * - * \return The Error code encountered + * \return 1 if the operation is successful or PROS_ERR if the operation failed, + * setting errno. */ virtual std::int32_t disable_gesture();