Minor documentation improvements for Scheme functions.

[lilypond.git] / lily / simple-closure.cc

diff --git a/lily/simple-closure.cc b/lily/simple-closure.cc
index 22ee294f49916b9e283c19745b944eafe7bb9673..48d2dab57b39d7da2d466cc45ee85c262cfd43ae 100644 (file)
--- a/lily/simple-closure.cc
+++ b/lily/simple-closure.cc
@@ -1,10 +1,21 @@
 /*
-  closure.cc -- chained closures.
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 2005--2010 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
-  (c) 2005--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
+  LilyPond 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 3 of the License, or
+  (at your option) any later version.
+
+  LilyPond 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 LilyPond.  If not, see <http://www.gnu.org/licenses/>.
 */
 #include "simple-closure.hh"
 
@@ -84,17 +95,18 @@ evaluate_with_simple_closure (SCM delayed_argument,
 }
 
 LY_DEFINE (ly_simple_closure_p, "ly:simple-closure?",
-         1,0,0, (SCM clos),
-         "Type predicate.")
+         1, 0, 0, (SCM clos),
+         "Is @var{clos} a simple closure?")
 {
   return scm_from_bool (is_simple_closure (clos));
 }
 
 LY_DEFINE (ly_make_simple_closure, "ly:make-simple-closure",
          1, 0, 0, (SCM expr),
-         "Make a simple closure. @var{expr} should be form of "
-         "@code{(@var{func} @var{a1} @var{A2} ...)}, and will be invoked "
-         "as @code{(@var{func} @var{delayed-arg} @var{a1} @var{a2} ... )}.")
+         "Make a simple closure.  @var{expr} should be form of"
+         " @code{(@var{func} @var{a1} @var{a2} @dots{})}, and will be"
+         " invoked as @code{(@var{func} @var{delayed-arg} @var{a1}"
+         " @var{a2} @dots{})}.")
 {
   SCM z;
 
@@ -104,9 +116,9 @@ LY_DEFINE (ly_make_simple_closure, "ly:make-simple-closure",
 
 LY_DEFINE (ly_eval_simple_closure, "ly:eval-simple-closure",
          2, 2, 0, (SCM delayed, SCM closure, SCM scm_start, SCM scm_end),
-         "Evaluate a simple closure with the given delayed argument. "
-         "If start and end are defined, evaluate it purely with those "
-         "start- and end-points.")
+         "Evaluate a simple @var{closure} with the given @var{delayed}"
+         " argument.  If @var{scm-start} and @var{scm-end} are defined,"
+         " evaluate it purely with those start and end points.")
 {
   bool pure = (scm_is_number (scm_start) && scm_is_number (scm_end));
   int start = robust_scm2int (scm_start, 0);