Minor documentation improvements for Scheme functions.

[lilypond.git] / lily / score-scheme.cc

diff --git a/lily/score-scheme.cc b/lily/score-scheme.cc
index 83111f670755cf74ae935c1ff5a938dcf4b9205e..fe08bef253bd04a87c73bb835e6d8d06a5bc42ec 100644 (file)
--- a/lily/score-scheme.cc
+++ b/lily/score-scheme.cc
@@ -1,9 +1,20 @@
 /*
-  score-scheme.cc -- implement Score bindings.
+  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 "score.hh"
@@ -18,7 +29,7 @@
 LY_DEFINE (ly_make_score, "ly:make-score",
           1, 0, 0,
           (SCM music),
-          "Return score with @var{music} encapsulated in @var{score}.")
+          "Return score with @var{music} encapsulated in it.")
 {
   LY_ASSERT_SMOB (Music, music, 1);
 
@@ -30,7 +41,7 @@ LY_DEFINE (ly_make_score, "ly:make-score",
 
 LY_DEFINE (ly_score_output_defs, "ly:score-output-defs",
           1, 0, 0, (SCM score),
-          "All output defs in a score.")
+          "All output definitions in a score.")
 {
   LY_ASSERT_SMOB (Score, score, 1);
   Score *sc = unsmob_score (score);
@@ -41,21 +52,43 @@ LY_DEFINE (ly_score_output_defs, "ly:score-output-defs",
   return scm_reverse_x (l, SCM_EOL);
 }
 
-
+LY_DEFINE (ly_score_add_output_def_x, "ly:score-add-output-def!",
+          2, 0, 0, (SCM score, SCM def),
+          "Add an output definition @var{def} to @var{score}.")
+{
+  LY_ASSERT_SMOB (Score, score, 1);
+  LY_ASSERT_SMOB (Output_def, def, 2);
+  Score *sc = unsmob_score (score);
+  Output_def *output_def = unsmob_output_def (def);
+  sc->add_output_def (output_def);
+  return SCM_UNSPECIFIED;
+}
 
 LY_DEFINE (ly_score_header, "ly:score-header",
           1, 0, 0, (SCM score),
-          "return score header.")
+          "Return score header.")
 {
   LY_ASSERT_SMOB (Score, score, 1);
   Score *sc = unsmob_score (score);
-  return sc->header_;
+  return sc->get_header ();
 }
 
+LY_DEFINE (ly_score_set_header_x, "ly:score-set-header!",
+          2, 0, 0, (SCM score, SCM module),
+          "Set the score header.")
+{
+  LY_ASSERT_SMOB (Score, score, 1);
+  SCM_ASSERT_TYPE (ly_is_module (module), module, SCM_ARG2, __FUNCTION__,
+                  "module");
+
+  Score *sc = unsmob_score (score);
+  sc->set_header (module);
+  return SCM_UNSPECIFIED;
+}
 
 LY_DEFINE (ly_score_music, "ly:score-music",
           1, 0, 0, (SCM score),
-          "return score music.")
+          "Return score music.")
 {
   LY_ASSERT_SMOB (Score, score, 1);
   Score *sc = unsmob_score (score);
@@ -73,10 +106,9 @@ LY_DEFINE (ly_score_error_p, "ly:score-error?",
 
 LY_DEFINE (ly_score_embedded_format, "ly:score-embedded-format",
           2, 0, 0, (SCM score, SCM layout),
-          "Run @var{score} through @var{layout}, an output definition, "
-          "scaled to correct output-scale already, "
-          "return a list of layout-lines. "
-          "\nTake optional Object_key argument.")
+          "Run @var{score} through @var{layout} (an output definition)"
+          " scaled to correct output-scale already, returning a list of"
+          " layout-lines.")
 {
   LY_ASSERT_SMOB (Score, score, 1);
   LY_ASSERT_SMOB (Output_def, layout, 2);