search

CrossTheRoadElec / Phoenix-api

CTRE Phoenix language API (targets FIRST Robotics Competition, Linux, RaspPi, Windows)
Other
39 stars 28 forks source link

No documentation for config_**(int slotIdx, double value) methods #60

Closed retrodaredevil closed 5 years ago

retrodaredevil commented 5 years ago

In BaseMotorController each config_**(int slotIdx, double value, int timeoutMs) has documentation while each one without a timeoutMs parameter is missing documentation. This makes pulling up the documentation in IDEs slightly more of a hassle. Example: https://github.com/CrossTheRoadElec/Phoenix-api/blob/master/java/src/com/ctre/phoenix/motorcontrol/can/BaseMotorController.java on line 1222

JCaporuscio commented 5 years ago

I agree that this is an issue.
This is being worked on and will be corrected in a future release (though no exact eta).

JCaporuscio commented 5 years ago

As of the update to latest Phoenix version, this should be resolved for all config* functions in both C++ and Java.

Example: https://github.com/CrossTheRoadElec/Phoenix-api/blob/master/src/main/java/com/ctre/phoenix/motorcontrol/can/BaseMotorController.java#L1581