Skip to content

Commit

Permalink
Editing comments
Browse files Browse the repository at this point in the history
  • Loading branch information
kunwarsahni01 committed Oct 28, 2020
1 parent 355b567 commit 1461d03
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 7 deletions.
9 changes: 4 additions & 5 deletions include/pros/optical.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
*
Expand All @@ -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:
Expand All @@ -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);

Expand Down
6 changes: 4 additions & 2 deletions include/pros/optical.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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();

Expand All @@ -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();

Expand Down

0 comments on commit 1461d03

Please sign in to comment.