[wpilibc] Add doxygen deprecated tag to deprecated methods (#2336)

This commit is contained in:
sciencewhiz
2020-03-31 20:43:04 -07:00
committed by GitHub
parent 43574128b3
commit 3a5e541b2d
18 changed files with 125 additions and 22 deletions

View File

@@ -1,5 +1,5 @@
/*----------------------------------------------------------------------------*/
/* Copyright (c) 2008-2019 FIRST. All Rights Reserved. */
/* Copyright (c) 2008-2020 FIRST. All Rights Reserved. */
/* Open Source Software - may be modified and shared by FRC teams. The code */
/* must be accompanied by the FIRST BSD license file in the root directory of */
/* the project. */
@@ -17,10 +17,12 @@ namespace frc {
* Common interface for controllers. Controllers run control loops, the most
* common are PID controllers and their variants, but this includes anything
* that is controlling an actuator in a separate thread.
*
* @deprecated Only used by the deprecated PIDController
*/
class Controller {
public:
WPI_DEPRECATED("None of the 2020 FRC controllers use this.")
WPI_DEPRECATED("Only used by the deprecated PIDController")
Controller() = default;
virtual ~Controller() = default;