From 0497dfb79211aa1e64304fa446d230c41ca73daa Mon Sep 17 00:00:00 2001
From: Camil Staps
Date: Fri, 1 Nov 2019 18:41:10 +0100
Subject: Cleanup and add documentation

---
 src/Gtk/Widgets/Sheet.dcl | 13 +++++++++++++
 1 file changed, 13 insertions(+)

(limited to 'src/Gtk/Widgets/Sheet.dcl')

diff --git a/src/Gtk/Widgets/Sheet.dcl b/src/Gtk/Widgets/Sheet.dcl
index 2541242..0f365d2 100644
--- a/src/Gtk/Widgets/Sheet.dcl
+++ b/src/Gtk/Widgets/Sheet.dcl
@@ -4,6 +4,8 @@ definition module Gtk.Widgets.Sheet
  * This module provides support for GtkSheet; a spreadsheet widget. See
  * https://fpaquet.github.io/gtksheet/ for more details and installation
  * instructions. Use the 'Gtk with GtkSheet' environment.
+ *
+ * Note that the C library is slightly buggy.
  */
 
 from StdMaybe import :: Maybe
@@ -26,8 +28,19 @@ instance gtkWidget GtkSheet
 instance gtkContainer GtkSheet
 
 newSheet :: !Int !Int !String -> GtkM GtkSheet
+
+/**
+ * Freezing a sheet means that the GUI will not be updated; all model updates
+ * are collected and the GUI is updated in a single step when the sheet is
+ * unfrozen. This is a wrapper function which freezes the sheet, executes the
+ * monad, and then unfreezes the sheet again.
+ */
 whileFrozen :: !(GtkM a) !GtkSheet -> GtkM a
 
+/**
+ * Make sure the sheet has the given width and height by adding or deleting
+ * rows and columns.
+ */
 ensureDimensions :: !Int !Int !GtkSheet -> GtkM GtkSheet
 
 setColumnTitle :: !Int !String !GtkSheet -> GtkM GtkSheet
-- 
cgit v1.2.3