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 <vmiklos@collabora.com>
This commit is contained in:
Miklos Vajna 2023-12-04 20:05:57 +01:00
parent 59a0be15b0
commit 9c02160fc5

View file

@ -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