aboutsummaryrefslogtreecommitdiff
path: root/doc/ref/vcomponent/group.texi
diff options
context:
space:
mode:
Diffstat (limited to 'doc/ref/vcomponent/group.texi')
-rw-r--r--doc/ref/vcomponent/group.texi20
1 files changed, 20 insertions, 0 deletions
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