AtHeartEngineer/kami
1
0
Fork 0
mirror of https://github.com/JHUAPL/kami.git synced 2026-01-08 14:33:53 -05:00
Code Issues Packages Projects Releases Wiki Activity

Comment alignment fix

Browse Source
This commit is contained in:
James P. Howard, II
2022-08-04 22:09:39 -04:00
parent 0015cdbd5a
commit 2d88d32bd6
1 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
include/kami/agent.h
View File

@@ -183,18 +183,18 @@ namespace kami {
friend bool operator!=(const Agent &lhs, const Agent &rhs);
};
/**
* @brief A superclass for all staged agents.
*
* @details Staged agents use a two-phase step to allow agents to take actions without
* updating the state of the model before all agents have been allowed to
* update. All work necessary to advance the `StagedAgent` state should take
* place in the `step()` function. However, the `StagedAgent` should not actually
* update the state, and instead save the results for later use. Finally,
* during the `advance()` stage, the StagedAgent state should update.
*
* `StagedAgents` must implement both the `step()` and `advance()` functions.
*/
/**
* @brief A superclass for all staged agents.
*
* @details Staged agents use a two-phase step to allow agents to take actions without
* updating the state of the model before all agents have been allowed to
* update. All work necessary to advance the `StagedAgent` state should take
* place in the `step()` function. However, the `StagedAgent` should not actually
* update the state, and instead save the results for later use. Finally,
* during the `advance()` stage, the StagedAgent state should update.
*
* `StagedAgents` must implement both the `step()` and `advance()` functions.
*/
class LIBKAMI_EXPORT StagedAgent : public Agent {
public:
/**