[Libreoffice-commits] core.git: sc/inc

[Eike Rathke]

 sc/inc/chgtrack.hxx |   18 ++++++++++++------
 1 file changed, 12 insertions(+), 6 deletions(-)

New commits:
commit 1fed7ec4e47fd1241a15e21cd0ef6d0cce7d151b
Author: Eike Rathke <erack at redhat.com>
Date:   Thu Nov 10 13:29:29 2016 +0100

    clarify class documentation
    
    Change-Id: I282a438159b9862034ba9fe4acdf87bf859b0465

diff --git a/sc/inc/chgtrack.hxx b/sc/inc/chgtrack.hxx
index aea3fe6..f00194d 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;