summaryrefslogtreecommitdiff
path: root/sw/inc
diff options
context:
space:
mode:
authorMiklos Vajna <vmiklos@collabora.com>2024-03-12 08:19:21 +0100
committerMiklos Vajna <vmiklos@collabora.com>2024-03-12 09:24:57 +0100
commit9a7b26a994362a71944f675c9c9ccffffe8fa517 (patch)
tree65eb3b700d42ed299801a5c44ad5c80991268960 /sw/inc
parente2708fecb34fb4084f8db5f2c5ffb4d8923002ca (diff)
sw: extend the SwFormatChg documentation a little
It's not directly SwFormatChg that describes the change of a format, it's sw::LegacyModifyHint that has pointers to the old and new pool items, which can be SwFormatChg / RES_FMT_CHG. Change-Id: I997d63ea380fbd8cc6434982d348edad2e4bb44b Reviewed-on: https://gerrit.libreoffice.org/c/core/+/164698 Reviewed-by: Miklos Vajna <vmiklos@collabora.com> Tested-by: Jenkins
Diffstat (limited to 'sw/inc')
-rw-r--r--sw/inc/hints.hxx5
1 files changed, 4 insertions, 1 deletions
diff --git a/sw/inc/hints.hxx b/sw/inc/hints.hxx
index b3d400e06286..fa7a78200a26 100644
--- a/sw/inc/hints.hxx
+++ b/sw/inc/hints.hxx
@@ -65,9 +65,12 @@ public:
{}
};
-/*
+/**
* SwFormatChg is sent when a format has changed to another format. 2 Hints are always sent
* the old and the new format
+ *
+ * This is typically owned by an sw::LegacyModifyHint, which knows if this pool item is the old or
+ * the new format.
*/
class SwFormatChg final : public SwMsgPoolItem
{