[nongnu] elpa/annotate ce8dfa5ae9 110/372: - added docstrings.

[ELPA Syncer]

branch: elpa/annotate
commit ce8dfa5ae955167990113768bb8a55b313c92935
Author: cage <cage-invalid@invalid>
Commit: cage <cage-invalid@invalid>

    - added docstrings.
---
 annotate.el | 17 +++++++++++++----
 1 file changed, 13 insertions(+), 4 deletions(-)

diff --git a/annotate.el b/annotate.el
index 7c1170100c..7ad1e48da6 100644
--- a/annotate.el
+++ b/annotate.el
@@ -184,22 +184,31 @@ major mode is a member of this list (space separated 
entries)."
      (setf inhibit-modification-hooks t)))
 
 (defun annotate-end-of-line-pos ()
+ "Get the position of the end of line and rewind the point's
+postion (so that it is unchanged after this function is called)."
   (save-excursion
     (end-of-line)
     (point)))
 
 (defun annotate-beginning-of-line-pos ()
+  "Get the position of the beginning of line and rewind the point's
+postion (so that it is unchanged after this function is called)."
   (save-excursion
     (beginning-of-line)
     (point)))
 
 (defun annotate-before-change-fn (a b)
+ "This function is added to 'before-change-functions' hook and
+it is called any time the buffer content is changed (so, for
+example, text is added or deleted). In particular, it will
+rearrange the overlays bounds when an annotated text is
+modified (for example a newline is inserted)."
   (annotate-with-inhibit-modification-hooks
    (save-excursion
-     (let* ((bol      (annotate-beginning-of-line-pos))
-            (eol      (annotate-end-of-line-pos))
-            (ov       (cl-remove-if-not 'annotationp
-                                        (overlays-in bol eol))))
+     (let* ((bol (annotate-beginning-of-line-pos))
+            (eol (annotate-end-of-line-pos))
+            (ov  (cl-remove-if-not 'annotationp
+                                   (overlays-in bol eol))))
        (dolist (overlay ov)
          (annotate--remove-annotation-property (overlay-start overlay)
                                                (overlay-end   overlay))