Skip to content

Commit

Permalink
Command: Add documentation to existing methods
Browse files Browse the repository at this point in the history
Added documentation to existing methods in Command class.
  • Loading branch information
tetektoza committed Nov 30, 2023
1 parent 98ead68 commit 74a9a86
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions source/command.cpp
Original file line number Diff line number Diff line change
@@ -1,10 +1,21 @@
#include "command.h"

/**
* @brief Sets if a command is obsolete or not
*
* This function sets if a command is obsolete or not.
* This flag will be used in UndoStack to check if a
* command should be popped whenever there will be undo/redo
* operation used, or user pushes any command onto the stack.
*/
void Command::setObsolete(bool isObsolete)
{
m_isObsolete = isObsolete;
}

/**
* @brief Returns if a command is obsolete or not
*/
bool Command::isObsolete() const
{
return m_isObsolete;
Expand Down

0 comments on commit 74a9a86

Please sign in to comment.