Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-06-28 02:11:43 +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

25
wpiutil/src/main/native/include/wpi/UidVector.h
View File

@@ -60,12 +60,15 @@ class UidVectorIterator {
};
} // namespace impl
// Vector which provides an integrated freelist for removal and reuse of
// individual elements.
// @tparam T element type; must be default-constructible and evaluate in
// boolean context to false when "empty"
// @tparam reuse_threshold how many free elements to store up before starting
// to recycle them
/**
* Vector which provides an integrated freelist for removal and reuse of
* individual elements.
*
* @tparam T element type; must be default-constructible and evaluate in
* boolean context to false when "empty"
* @tparam reuse_threshold how many free elements to store up before starting
* to recycle them
*/
template <typename T, typename std::vector<T>::size_type reuse_threshold>
class UidVector {
public:
@@ -103,8 +106,10 @@ class UidVector {
return uid;
}
// Removes the identified element by replacing it with a default-constructed
// one. The element is added to the freelist for later reuse.
/**
* Removes the identified element by replacing it with a default-constructed
* one. The element is added to the freelist for later reuse.
*/
T erase(size_type uid) {
if (uid >= m_vector.size() || !m_vector[uid]) {
return T();
@@ -116,7 +121,9 @@ class UidVector {
return rv;
}
// Removes all elements.
/**
* Removes all elements.
*/
void clear() noexcept {
m_vector.clear();
m_free.clear();