Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-06-22 01:11:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

[docs] Fix Doxygen warnings, add CI docs lint job (#3639)

Browse Source 
The CI docs lint build is configured to fail on Doxygen warnings.
This commit is contained in:
Tyler Veness
2021-10-14 18:09:38 -07:00
committed by GitHub
parent 4ad3a54026
commit 4647d09b50
125 changed files with 1723 additions and 1131 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
wpiutil/src/main/native/include/wpi/SafeThread.h
View File

@@ -15,7 +15,9 @@
namespace wpi {
// Base class for SafeThreadOwner threads.
/**
* Base class for SafeThreadOwner threads.
*/
class SafeThread {
public:
virtual ~SafeThread() = default;
@@ -29,7 +31,9 @@ class SafeThread {
namespace detail {
// Non-template proxy base class for common proxy code.
/**
* Non-template proxy base class for common proxy code.
*/
class SafeThreadProxyBase {
public:
explicit SafeThreadProxyBase(std::shared_ptr<SafeThread> thr);
@@ -41,8 +45,11 @@ class SafeThreadProxyBase {
std::unique_lock<wpi::mutex> m_lock;
};
// A proxy for SafeThread.
// Also serves as a scoped lock on SafeThread::m_mutex.
/**
* A proxy for SafeThread.
*
* Also serves as a scoped lock on SafeThread::m_mutex.
*/
template <typename T>
class SafeThreadProxy : public SafeThreadProxyBase {
public:
@@ -52,7 +59,9 @@ class SafeThreadProxy : public SafeThreadProxyBase {
T* operator->() const { return static_cast<T*>(m_thread.get()); }
};
// Non-template owner base class for common owner code.
/**
* Non-template owner base class for common owner code.
*/
class SafeThreadOwnerBase {
public:
void Stop();