Merge with master

[lilypond.git] / lily / text-interface.cc

diff --git a/lily/text-interface.cc b/lily/text-interface.cc
index eec815089429a4ff115244552bbcea2e33c46535..55e7bb7ec4c09a81ed73185271ef0c00a3ab3ef3 100644 (file)
--- a/lily/text-interface.cc
+++ b/lily/text-interface.cc
@@ -25,20 +25,25 @@ Text_interface::interpret_string (SCM layout_smob,
                                  SCM props,
                                  SCM markup)
 {
-  Output_def *layout = unsmob_output_def (layout_smob);
-
-  SCM_ASSERT_TYPE (layout, layout_smob, SCM_ARG1,
-                  __FUNCTION__, "Layout definition");
-  SCM_ASSERT_TYPE (scm_is_string (markup), markup, SCM_ARG3,
-                  __FUNCTION__, "string");
+  LY_ASSERT_SMOB (Output_def, layout_smob, 1);
+  LY_ASSERT_TYPE (scm_is_string, markup, 3);
 
   string str = ly_scm2string (markup);
-
+  Output_def *layout = unsmob_output_def (layout_smob);
   Font_metric *fm = select_encoded_font (layout, props);
   return fm->word_stencil (str).smobbed_copy ();
 }
 
-MAKE_SCHEME_CALLBACK (Text_interface, interpret_markup, 3);
+MAKE_SCHEME_CALLBACK_WITH_OPTARGS (Text_interface, interpret_markup, 3, 0,
+                                  "Convert a text markup into a stencil. "
+"Takes 3 arguments, @var{layout}, @var{props} and @var{markup}. "
+"\n\n"
+"@var{layout} is a @code{\\layout} block; it may be obtained from a grob with "
+"@code{ly:grob-layout}.  @var{props} is a alist chain, ie. a list of alists. "
+"This is typically obtained with "
+"@code{(ly:grob-alist-chain (ly:layout-lookup layout 'text-font-defaults))}. "
+"@var{markup} is the markup text to be processed. "
+                                  );
 SCM
 Text_interface::interpret_markup (SCM layout_smob, SCM props, SCM markup)
 {
@@ -92,7 +97,13 @@ Text_interface::is_markup (SCM x)
 }
 
 ADD_INTERFACE (Text_interface,
-              "A scheme markup text, see @usermanref{Text markup}.",
+              "A scheme markup text, see @usermanref{Text markup} and "
+              "@usermanref{New markup command definition}. "
+              "\n\n"
+              "There are two important commands: ly:text-interface::print, which is a "
+              "grob callback, and ly:text-interface::interpret-markup ",
+
+              /* props */
               "baseline-skip "
               "text "
               "word-space "