commit d87ce2c91f9353b55e8a13199e8eb1a713703d5c
Author: Jean-Marc Lasgouttes <[email protected]>
Date: Thu Jul 16 16:29:55 2015 +0200
Update comment.
diff --git a/src/Cursor.h b/src/Cursor.h
index 4ca5f31..eab5367 100644
--- a/src/Cursor.h
+++ b/src/Cursor.h
@@ -538,10 +538,11 @@ public:
/**
- * Notifies all insets which appear in old, but not in cur. And then
- * notify all insets which appear in cur, but not in old.
- * Make sure that the cursor old is valid, i.e. all inset pointers
- * point to valid insets! Use Cursor::fixIfBroken if necessary.
+ * Notifies all insets which appear in \c old, but not in \c cur. And then
+ * notify all insets which appear in \c cur, but not in \c old.
+ * \returns true if cursor is now invalid, e.g. if some insets in
+ * higher cursor slices of \c old do not exist anymore. In this case
+ * it may be necessary to use Use Cursor::fixIfBroken.
*/
bool notifyCursorLeavesOrEnters(Cursor const & old, Cursor & cur);
