Docs: IR: clean up Paper_book callback docstrings

[lilypond.git] / lily / paper-book-scheme.cc

diff --git a/lily/paper-book-scheme.cc b/lily/paper-book-scheme.cc
index 37cf9874e419cf9cfb211f7e37643dac1d019706..8306c79585ea5cdb0b99ee42020a2b65aa43fbbe 100644 (file)
--- a/lily/paper-book-scheme.cc
+++ b/lily/paper-book-scheme.cc
@@ -1,10 +1,9 @@
 /*
-  paper-book-scheme.cc --  implement Paper_book bindings
+  paper-book-scheme.cc -- implement Paper_book bindings
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 2005 Han-Wen Nienhuys <hanwen@xs4all.nl>
-
+  (c) 2005--2009 Han-Wen Nienhuys <hanwen@xs4all.nl>
 */
 
 #include "paper-book.hh"
@@ -12,36 +11,53 @@
 #include "output-def.hh"
 
 LY_DEFINE (ly_paper_book_pages, "ly:paper-book-pages",
-         1, 0, 0, (SCM pb),
-         "Return pages in book PB.")
+          1, 0, 0, (SCM pb),
+          "Return pages in @code{Paper_book} object @var{pb}.")
 {
-  return unsmob_paper_book(pb)->pages ();
+  LY_ASSERT_SMOB (Paper_book, pb, 1);
+  return unsmob_paper_book (pb)->pages ();
 }
 
 LY_DEFINE (ly_paper_book_scopes, "ly:paper-book-scopes",
-         1, 0, 0, (SCM book),
-         "Return pages in layout book @var{book}.")
+          1, 0, 0, (SCM pb),
+          "Return scopes in @code{Paper_book} object @var{pb}.")
 {
-  Paper_book *pb = unsmob_paper_book(book);
-  SCM_ASSERT_TYPE(pb, book, SCM_ARG1, __FUNCTION__, "Paper_book");
-  
+  LY_ASSERT_SMOB (Paper_book, pb, 1);
+  Paper_book *book = unsmob_paper_book (pb);
+
   SCM scopes = SCM_EOL;
-  if (ly_c_module_p (pb->header_))
-    scopes = scm_cons (pb->header_, scopes);
-  
+  if (book->parent_)
+    {
+      scopes = ly_paper_book_scopes (book->parent_->self_scm ());
+    }
+  if (ly_is_module (book->header_))
+    scopes = scm_cons (book->header_, scopes);
+
   return scopes;
 }
 
+LY_DEFINE (ly_paper_book_performances, "ly:paper-book-performances",
+          1, 0, 0, (SCM pb),
+          "Return performances in @code{Paper_book} object @var{pb}.")
+{
+  LY_ASSERT_SMOB (Paper_book, pb, 1);
+  return unsmob_paper_book (pb)->performances ();
+}
+
 LY_DEFINE (ly_paper_book_systems, "ly:paper-book-systems",
           1, 0, 0, (SCM pb),
-          "Return systems in book PB.")
+          "Return systems in @code{Paper_book} object @var{pb}.")
 {
+  LY_ASSERT_SMOB (Paper_book, pb, 1);
   return unsmob_paper_book (pb)->systems ();
 }
 
 LY_DEFINE (ly_paper_book_paper, "ly:paper-book-paper",
-         1, 0, 0, (SCM pb),
-         "Return pages in book PB.")
+          1, 0, 0, (SCM pb),
+          "Return the paper output definition (@code{\\paper})"
+          " in @code{Paper_book} object @var{pb}.")
 {
-  return unsmob_paper_book (pb)->paper_->self_scm ();
+  LY_ASSERT_SMOB (Paper_book, pb, 1);
+  Paper_book *pbook = unsmob_paper_book (pb);
+  return pbook->paper_->self_scm ();
 }