From 848280d1f1f38059c02af0ba57b38d0affed2f2d Mon Sep 17 00:00:00 2001 From: sciencewhiz Date: Wed, 23 Aug 2017 21:58:21 -0700 Subject: [PATCH] Improve C++ Compressor documentation based on Java's docs. (#607) --- wpilibc/src/main/native/include/Compressor.h | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/wpilibc/src/main/native/include/Compressor.h b/wpilibc/src/main/native/include/Compressor.h index 7bb7e8dca8..320738c7e0 100644 --- a/wpilibc/src/main/native/include/Compressor.h +++ b/wpilibc/src/main/native/include/Compressor.h @@ -18,7 +18,17 @@ namespace frc { /** - * PCM compressor + * Class for operating a compressor connected to a %PCM (Pneumatic Control + * Module). The %PCM will automatically run in closed loop mode by default + * whenever a Solenoid object is created. For most cases, a Compressor object + * does not need to be instantiated or used in a robot program. This class is + * only required in cases where the robot program needs a more detailed status + * of the compressor or to enable/disable closed loop control. + * + * Note: you cannot operate the compressor directly from this class as doing so + * would circumvent the safety provided by using the pressure switch and closed + * loop control. You can only turn off closed loop control, thereby stopping + * the compressor from operating. */ class Compressor : public SensorBase, public LiveWindowSendable,