diff options
author | Eike Rathke <erack@redhat.com> | 2016-11-10 13:29:29 +0100 |
---|---|---|
committer | Eike Rathke <erack@redhat.com> | 2016-11-10 13:30:13 +0100 |
commit | 1fed7ec4e47fd1241a15e21cd0ef6d0cce7d151b (patch) | |
tree | b27bb9b24b5a29492fd43200ad3096a5ced2bb19 /sc/inc | |
parent | 6eb3d90aeb9438bd3249aaae32a445e81f278879 (diff) |
clarify class documentation
Change-Id: I282a438159b9862034ba9fe4acdf87bf859b0465
Diffstat (limited to 'sc/inc')
-rw-r--r-- | sc/inc/chgtrack.hxx | 18 |
1 files changed, 12 insertions, 6 deletions
diff --git a/sc/inc/chgtrack.hxx b/sc/inc/chgtrack.hxx index aea3fe6ccfb7..f00194da025f 100644 --- a/sc/inc/chgtrack.hxx +++ b/sc/inc/chgtrack.hxx @@ -85,14 +85,20 @@ enum ScChangeActionClipMode SC_CACM_PASTE }; -// ScChangeActionLinkEntry -// Inserts itself as the head of a chain (better: linked list?), or before a LinkEntry -// on delete: automatically remove of what is linked (German original was strange...) -// ppPrev == &previous->pNext oder address of pointer to head of linked list, -// *ppPrev == this - class ScChangeAction; +/** A link/connection/dependency between change actions. + + Upon construction inserts itself as the head of a chain / linked list, + respectively between existing link entries. + + Upon destruction removes itself from the list and connects the previous and + next entry, if it was the first entry automatically maintaining the head + pointer to the list. + + ppPrev == &previous->pNext or address of pointer to head of linked list, + *ppPrev == this + */ class ScChangeActionLinkEntry { ScChangeActionLinkEntry( const ScChangeActionLinkEntry& ) = delete; |