Add commentary; nfc.
authorThien-Thi Nguyen <ttn@gnuvola.org>
Sat, 28 Apr 2001 18:54:16 +0000 (18:54 +0000)
committerThien-Thi Nguyen <ttn@gnuvola.org>
Sat, 28 Apr 2001 18:54:16 +0000 (18:54 +0000)
ice-9/threads.scm
ice-9/time.scm

index b5d0cf9..631f5d8 100644 (file)
 ;;;; ----------------------------------------------------------------
 ;;;;
 \f
+;;; Commentary:
+
+;; This module is documented in the Guile Reference Manual.
+;; Briefly, one procedure is exported: `%thread-handler';
+;; as well as four macros: `make-thread', `begin-thread',
+;; `with-mutex' and `monitor'.
+
+;;; Code:
 
 (define-module (ice-9 threads))
 
index 72f2fba..658ffbe 100644 (file)
@@ -1,21 +1,33 @@
 ;;;;   Copyright (C) 2001 Free Software Foundation, Inc.
-;;;; 
+;;;;
 ;;;; This program is free software; you can redistribute it and/or modify
 ;;;; it under the terms of the GNU General Public License as published by
 ;;;; the Free Software Foundation; either version 2, or (at your option)
 ;;;; any later version.
-;;;; 
+;;;;
 ;;;; This program is distributed in the hope that it will be useful,
 ;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
 ;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 ;;;; GNU General Public License for more details.
-;;;; 
+;;;;
 ;;;; You should have received a copy of the GNU General Public License
 ;;;; along with this software; see the file COPYING.  If not, write to
 ;;;; the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
 ;;;; Boston, MA 02111-1307 USA
-;;;; 
+;;;;
 \f
+;;; Commentary:
+
+;; This module exports a single macro: `time'.
+;; Usage: (time exp)
+;;
+;; Example:
+;; guile> (time (sleep 3))
+;; clock utime stime cutime cstime gctime
+;; 3.01  0.00  0.00   0.00   0.00   0.00
+;; 0
+
+;;; Code:
 
 (define-module (ice-9 time)
   :use-module (ice-9 format)
@@ -41,3 +53,5 @@
 
 (define-macro (time exp)
   `(,time-proc (lambda () ,exp)))
+
+;;; time.scm ends here