Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-07-04 03:11:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

8
wpilibc/src/main/native/include/frc/Watchdog.h
View File

@@ -1,5 +1,5 @@
/*----------------------------------------------------------------------------*/
/* Copyright (c) 2018-2019 FIRST. All Rights Reserved. */
/* Copyright (c) 2018-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. */
@@ -34,6 +34,9 @@ class Watchdog {
/**
* Watchdog constructor.
*
* @deprecated use unit-safe version instead.
* Watchdog(units::second_t timeout, std::function<void()> callback)
*
* @param timeout The watchdog's timeout in seconds with microsecond
* resolution.
* @param callback This function is called when the timeout expires.
@@ -74,6 +77,9 @@ class Watchdog {
/**
* Sets the watchdog's timeout.
*
* @deprecated use the unit safe version instead.
* SetTimeout(units::second_t timeout)
*
* @param timeout The watchdog's timeout in seconds with microsecond
* resolution.
*/