aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHugo Hörnquist <hugo@lysator.liu.se>2023-11-14 16:57:11 +0100
committerHugo Hörnquist <hugo@lysator.liu.se>2023-11-16 00:51:19 +0100
commit6ee54ced8b96c76e17c6a2ef3b65b53b9353d500 (patch)
tree4d66744e559bbc7173c09e7fef18ca276653890a
parentRemove (vcomponent util describe). (diff)
downloadcalp-6ee54ced8b96c76e17c6a2ef3b65b53b9353d500.tar.gz
calp-6ee54ced8b96c76e17c6a2ef3b65b53b9353d500.tar.xz
Document vcomponent grouping utilities.
-rw-r--r--doc/ref/vcomponent.texi1
-rw-r--r--doc/ref/vcomponent/group.texi20
2 files changed, 21 insertions, 0 deletions
diff --git a/doc/ref/vcomponent.texi b/doc/ref/vcomponent.texi
index 5823e88e..4e0fb2c7 100644
--- a/doc/ref/vcomponent.texi
+++ b/doc/ref/vcomponent.texi
@@ -9,6 +9,7 @@ the generialization of VCALENDAR, VEVENT, ...
Some of these values are still Calp specific.
@include vcomponent/general.texi
+@include vcomponent/group.texi
@include vcomponent/create.texi
@include vcomponent/data-formats.texi
diff --git a/doc/ref/vcomponent/group.texi b/doc/ref/vcomponent/group.texi
new file mode 100644
index 00000000..27e94732
--- /dev/null
+++ b/doc/ref/vcomponent/group.texi
@@ -0,0 +1,20 @@
+@node VComponent Grouping Utilities
+@section VComponent Grouping Utilities
+
+@code{(vcomponent util group)}
+
+@defun group-stream input-stream
+Given a sorted stream of vevent's, where each MUST have at least a
+DTSTART property, returns a new stream of pairs of dates and all
+events from the original streams which at least in part reside inside
+that date.
+@end defun
+
+@defun get-groups-between groups start-date end-date
+Returns the subset of @var{groups}, as generated by
+@code{group-stream}, which overlaps the date interval between
+@var{start-date} and @var{end-date}.
+@end defun
+
+@defun group->event-list group
+@end defun