From 42865cb25d714ad338bfdd0d8a17b8cf04783092 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Hugo=20H=C3=B6rnquist?= <hugo@lysator.liu.se>
Date: Thu, 14 Jan 2021 00:14:35 +0100
Subject: Add comments to some procedures.

---
 module/vcomponent/control.scm             | 1 +
 module/vcomponent/datetime.scm            | 7 +++++++
 module/vcomponent/recurrence/internal.scm | 4 ++++
 3 files changed, 12 insertions(+)

(limited to 'module/vcomponent')

diff --git a/module/vcomponent/control.scm b/module/vcomponent/control.scm
index add48c28..5fe5b8b0 100644
--- a/module/vcomponent/control.scm
+++ b/module/vcomponent/control.scm
@@ -22,6 +22,7 @@
                          (set! (prop component key) val))))
               keys)))
 
+;; TODO what is this even used for?
 (define-syntax with-replaced-properties
   (syntax-rules ()
     [(_ (component (key val) ...)
diff --git a/module/vcomponent/datetime.scm b/module/vcomponent/datetime.scm
index 887ae48b..ca4f90e9 100644
--- a/module/vcomponent/datetime.scm
+++ b/module/vcomponent/datetime.scm
@@ -68,6 +68,13 @@ Event must have the DTSTART and DTEND protperty set."
            date-difference datetime-difference)
        (prop e 'DTEND) (prop e 'DTSTART))))
 
+;;
+;; |-----|      extent of event
+;;     |-----|  time we are interested in,
+;;              defined through @var{start-date} and @var{end-date}
+;;     |X|      part of event within that time (X)
+;; 
+;; Returns the length of the interval (X).
 (define-public (event-length/clamped start-date end-date e)
   (let ((end (or (prop e 'DTEND)
                  (if (date? (prop e 'DTSTART))
diff --git a/module/vcomponent/recurrence/internal.scm b/module/vcomponent/recurrence/internal.scm
index 8e84a8b6..1b9dd405 100644
--- a/module/vcomponent/recurrence/internal.scm
+++ b/module/vcomponent/recurrence/internal.scm
@@ -51,6 +51,10 @@
                  freq until count interval bysecond byminute byhour
                  byday bymonthday byyearday byweekno bymonth bysetpos
                  wkst)
+  ;; TODO possibly validate fields here
+  ;; to prevent creation of invalid rules.
+  ;; This was made apparent when wkst was (incorrectly) set to MO,
+  ;; which later crashed generate-recurrence-set.
   (make-recur-rule% freq until count interval bysecond byminute byhour
                     byday bymonthday byyearday byweekno bymonth bysetpos
                     wkst))
-- 
cgit v1.2.3