Minor: add doxygen comments

This commit is contained in:
2025-09-18 13:54:30 +02:00
parent b2ecd1b628
commit e4be41e670
2 changed files with 57 additions and 8 deletions

View File

@@ -5,18 +5,42 @@
#include <memory>
class UpdateCommand;
/**
* @brief This class is responsible for calling the several binaries
* \ref ATBUpdateTool consists of.
*
* This class maintains a worklist, which conists of entries of type UpdateCommand.
*
* @see UpdateCommand
*/
class WorkList {
public:
/**
* @brief Actual worklist of items to be eecuted.
*/
std::vector<std::unique_ptr<UpdateCommand>> m_workList;
public:
unsigned m_workListIndex{0};
WorkList() = default;
/**
* \brief Put new work item into worklist.
*
* \tparam arg Work item to be added to worklist.
*/
template<typename T>
void push_back(T&& arg) {
m_workList.push_back(std::forward<T>(arg));
}
/**
* \brief Check if worklist is empty.
*
* \retval true if worklist is empty.
* \retval false otherwise.
*/
bool empty() const { return m_workList.empty(); }
// move constructor: pass in classes derived from UpdateCommand
@@ -28,10 +52,30 @@ public:
// , m_workListIndex(0) {
//}
unsigned nextExecIndex() const;
///**
// * \brief Put new work item into worklist.
// *
// */
//unsigned nextExecIndex() const;
/**
* \brief Put new work item into worklist.
*
*/
bool nextExec() const;
/**
* \brief Put new work item into worklist.
*
* \param last
*/
bool exec(bool last=false);
/**
* \brief Get current size of worklist.
*
* \retval Current size of worklist.
*/
unsigned size() { return m_workList.size(); }
};