sw/inc/fmtrfmrk.hxx | 9 +++++++--
1 file changed, 7 insertions(+), 2 deletions(-)
New commits:
commit 9c02160fc55bccc43d92c68ec5166a79d50e1528
Author: Miklos Vajna <vmik...@collabora.com>
AuthorDate: Mon Dec 4 20:05:57 2023 +0100
Commit: Miklos Vajna <vmik...@collabora.com>
CommitDate: Tue Dec 5 08:31:19 2023 +0100
sw: document SwFormatRefMark
Explain where this can appear, who owns it and where it can be found on
the UI.
Change-Id: I4096bc51ef03e50c65261e7356a4e593d1ba4c48
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/160323
Tested-by: Jenkins
Reviewed-by: Miklos Vajna <vmik...@collabora.com>
diff --git a/sw/inc/fmtrfmrk.hxx b/sw/inc/fmtrfmrk.hxx
index 8f708cf583ea..b41449fa97af 100644
--- a/sw/inc/fmtrfmrk.hxx
+++ b/sw/inc/fmtrfmrk.hxx
@@ -30,8 +30,13 @@
class SwTextRefMark;
class SwXReferenceMark;
-// ATT_REFMARK
-
+/// SfxPoolItem subclass that represents a reference mark (a position in the
document with a name,
+/// which has a start and may or may not have an end).
+///
+/// This can be used as a character format in the hints array of a text node,
it's owned by an
+/// SwTextRefMark.
+///
+/// It's Insert -> Cross-reference -> Cross-references -> set reference on the
UI.
class SAL_DLLPUBLIC_RTTI SwFormatRefMark final
: public SfxPoolItem
, public sw::BroadcastingModify
