Fix documentation of UndoGroupHelper

This commit is contained in:
Jean-Marc Lasgouttes 2021-11-12 16:47:41 +01:00
parent 16ce82d4f9
commit 3aab9ad25e

View File

@ -130,19 +130,18 @@ private:
/** Helper class to simplify the use of undo groups across several buffers. /** 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 * then ended as the object goes out of scope or the buffer is reset
* (see below) * (see below)
*/ */
class UndoGroupHelper { class UndoGroupHelper {
public: public:
// Create a new undo group for buffer \c buf.
UndoGroupHelper(Buffer * buf); UndoGroupHelper(Buffer * buf);
// End all created undo groups.
~UndoGroupHelper(); ~UndoGroupHelper();
/** Close the current undo group if necessary and create a new one // Create an additional undo group for buffer \c buf.
* for buffer \c buf.
*/
void resetBuffer(Buffer * buf); void resetBuffer(Buffer * buf);
private: private: