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

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

View File

@@ -82,17 +82,38 @@ class static_circular_buffer {
size_t m_index;
};
/**
* Returns begin iterator.
*/
iterator begin() { return iterator(this, 0); }
/**
* Returns end iterator.
*/
iterator end() {
return iterator(this, ::wpi::static_circular_buffer<T, N>::size());
}
/**
* Returns begin iterator.
*/
const_iterator begin() const { return const_iterator(this, 0); }
/**
* Returns end iterator.
*/
const_iterator end() const {
return const_iterator(this, ::wpi::static_circular_buffer<T, N>::size());
}
/**
* Returns begin iterator.
*/
const_iterator cbegin() const { return const_iterator(this, 0); }
/**
* Returns end iterator.
*/
const_iterator cend() const {
return const_iterator(this, ::wpi::static_circular_buffer<T, N>::size());
}