From: Jean-Marc Lasgouttes <lasgouttes@lyx.org>
Date: Fri, 12 Nov 2021 15:47:41 +0000 (+0100)
Subject: Fix documentation of UndoGroupHelper
X-Git-Url: https://git.lyx.org/gitweb/?a=commitdiff_plain;h=3aab9ad25edcd527868f8f2b8a26262255952966;p=features.git

Fix documentation of UndoGroupHelper
---

diff --git a/src/Undo.h b/src/Undo.h
index 887f7627e1..bdcf95458b 100644
--- a/src/Undo.h
+++ b/src/Undo.h
@@ -130,19 +130,18 @@ private:
 
 /** Helper class to simplify the use of undo groups across several buffers.
  *
- *  The undo group is created when the object is instanciated; it is
+ *  The undo group is created when the object is instantiated; it is
  *  then ended as the object goes out of scope or the buffer is reset
  *  (see below)
  */
 class UndoGroupHelper {
 public:
+	// Create a new undo group for buffer \c buf.
 	UndoGroupHelper(Buffer * buf);
-
+	// End all created undo groups.
 	~UndoGroupHelper();
 
-	/** Close the current undo group if necessary and create a new one
-	 * for buffer \c buf.
-	 */
+	// Create an additional undo group for buffer \c buf.
 	void resetBuffer(Buffer * buf);
 
 private: