Skip to content

Commit

Permalink
Fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
IHatePineapples committed Apr 13, 2024
1 parent 75582c6 commit 140b5af
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
18 changes: 9 additions & 9 deletions src/RoL/threaded/queue.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
#include <queue>
#include <string>

/***
/**
* \class concurrent_queue
*
* \brief Wraps around std::queue and as name implies, allows concurrent access
Expand All @@ -15,7 +15,7 @@
template <typename T>
class concurrent_queue
{
/***
/**
* \var q_
* \brief Underlying `std::queue`, protected by a mutex, `mtx_`.
*/
Expand All @@ -24,7 +24,7 @@ class concurrent_queue

public:

/***
/**
* \fn concurrent_queue()
*
* Default constructor.
Expand All @@ -36,7 +36,7 @@ class concurrent_queue
concurrent_queue<T> &operator=(const concurrent_queue<T> &) = delete;
concurrent_queue<T> &operator=(concurrent_queue<T> &&) = delete;

/***
/**
* \fn front()
* \returns `&` to first item.
*
Expand All @@ -45,7 +45,7 @@ class concurrent_queue
T &front();
const T &front() const;

/***
/**
* \fn back()
* \returns `&` to last item.
*
Expand All @@ -54,24 +54,24 @@ class concurrent_queue
T &back();
const T &back() const;

/***
/**
* \fn empty()
* \returns `true` if queue empty, `false` otherwise.
*/
bool empty() const;

/***
/**
* \fn size()
* \returns number of elements in the queue.
*/
std::size_t size() const;

/***
/**
* \fn push(T &&)
* \brief Push an item onto the stack, doing an `emplace_back()` in the background.
*/
void push(T &&);
/***
/**
* \fn pop()
* \brief Pops the first element of the queue, pointed to by `front()`.
*/
Expand Down
2 changes: 1 addition & 1 deletion src/test/test_parse.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
#include <boost/assert.hpp>

using namespace parse;
/***
/**
* \file test_parse.cpp
* \brief Sample test unit for the parsing utilies. Validates parsing output.
* \note Tests are to be run on the host.
Expand Down

0 comments on commit 140b5af

Please sign in to comment.