mirror of
https://github.com/wpilibsuite/allwpilib
synced 2026-06-19 00:41:43 +00:00
[wpilibc] Add doxygen deprecated tag to deprecated methods (#2336)
This commit is contained in:
@@ -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. */
|
||||
@@ -192,6 +192,9 @@ class Encoder : public ErrorBase,
|
||||
* the FPGA will report the device stopped. This is expressed
|
||||
* in seconds.
|
||||
*/
|
||||
WPI_DEPRECATED(
|
||||
"Use SetMinRate() in favor of this method. This takes unscaled periods "
|
||||
"and SetMinRate() scales using value from SetDistancePerPulse().")
|
||||
void SetMaxPeriod(double maxPeriod) override;
|
||||
|
||||
/**
|
||||
|
||||
Reference in New Issue
Block a user