From 6bcd27b957a5ffcfe7665b0979679510e3b2ae3d Mon Sep 17 00:00:00 2001
From: Mitch Curtis <mitch.curtis@qt.io>
Date: Tue, 10 May 2016 14:35:20 +0200
Subject: [PATCH] Document how to save an application using QUndoStack
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Change-Id: Ic61374d5b6ce395dfe8d0b30813ea437b5e16e9d
Task-number: QTBUG-52497
Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
---
 src/widgets/util/qundostack.cpp | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/src/widgets/util/qundostack.cpp b/src/widgets/util/qundostack.cpp
index 5bcfa57b377..bd41fb60c12 100644
--- a/src/widgets/util/qundostack.cpp
+++ b/src/widgets/util/qundostack.cpp
@@ -623,6 +623,8 @@ void QUndoStack::push(QUndoCommand *cmd)
     Marks the stack as clean and emits cleanChanged() if the stack was
     not already clean.
 
+    This is typically called when a document is saved, for example.
+
     Whenever the stack returns to this state through the use of undo/redo
     commands, it emits the signal cleanChanged(). This signal is also
     emitted when the stack leaves the clean state.
-- 
GitLab