Undostack: Add documentation for existing methods

Added documentation for existing methods in UndoStack class.
diasurgical · Nov 30, 2023 · 94222bc · 94222bc
1 parent 94a7055
commit 94222bc
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/source/undostack.cpp b/source/undostack.cpp
@@ -1,5 +1,13 @@
 #include "undostack.h"
 
+/**
+ * @brief Pushes new commands onto the commands stack (Undostack)
+ *
+ * This function pushes new commands onto the undo stack, and redos
+ * the command that got currently pushed, essentially triggering the command.
+ * It also erases any commands that had isObsolete flag set.
+ * Push also removes any commands that were currently undo'd on the stack.
+ */
 void UndoStack::push(std::unique_ptr<Command> cmd)
 {
     try {