sw/inc/fmtfld.hxx | 5 +++++
1 file changed, 5 insertions(+)
New commits:
commit 83cbadeaf6b784fa9ae2ca47d1a10bc942adfe79
Author: Miklos Vajna <[email protected]>
AuthorDate: Mon Dec 18 20:22:48 2023 +0100
Commit: Miklos Vajna <[email protected]>
CommitDate: Tue Dec 19 08:09:21 2023 +0100
sw: document SwFormatFieldHint
Describe the typical producer and typical consumer.
Change-Id: Iea2ae67f6a17bc5d84ce0bdc0690d13a22218ae4
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/160950
Tested-by: Jenkins
Reviewed-by: Miklos Vajna <[email protected]>
diff --git a/sw/inc/fmtfld.hxx b/sw/inc/fmtfld.hxx
index 0c8d5fda7110..ab1953f00114 100644
--- a/sw/inc/fmtfld.hxx
+++ b/sw/inc/fmtfld.hxx
@@ -180,6 +180,11 @@ enum class SwFormatFieldHintWhich
RESOLVED = 5
};
+/// This SfxHint subclass is produced by code that changes the doc model (e.g.
SwNodes::ChgNode()),
+/// the typical which id is SwFormatFieldHintWhich::INSERTED or
SwFormatFieldHintWhich::REMOVED.
+///
+/// The consumer of this hint is SwPostItMgr::Notify(), i.e. the sidebar on
the right hand side of
+/// the Writer edit window that hosts the comments as post-its.
class SW_DLLPUBLIC SwFormatFieldHint final : public SfxHint
{
const SwFormatField* m_pField;
