Minor documentation improvements for Scheme functions.

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

diff --git a/lily/general-scheme.cc b/lily/general-scheme.cc
index c8816b43a7902350c91fb7ddac2a146f7402e5c3..8359e8fc5bb3a2fce775369dc9a0e6955138cfa2 100644 (file)
--- a/lily/general-scheme.cc
+++ b/lily/general-scheme.cc
@@ -146,8 +146,8 @@ LY_DEFINE (ly_programming_error, "ly:programming-error",
 
 LY_DEFINE (ly_success, "ly:success",
           1, 0, 1, (SCM str, SCM rest),
-          "A Scheme callable function to issue a success message @code{str}."
-          "  The message is formatted with @code{format} and @code{rest}.")
+          "A Scheme callable function to issue a success message @var{str}."
+          "  The message is formatted with @code{format} and @var{rest}.")
 {
   LY_ASSERT_TYPE (scm_is_string, str, 1);
   str = scm_simple_format (SCM_BOOL_F, str, rest);
@@ -157,8 +157,8 @@ LY_DEFINE (ly_success, "ly:success",
 }
 LY_DEFINE (ly_warning, "ly:warning",
           1, 0, 1, (SCM str, SCM rest),
-          "A Scheme callable function to issue the warning @code{str}."
-          "  The message is formatted with @code{format} and @code{rest}.")
+          "A Scheme callable function to issue the warning @var{str}."
+          "  The message is formatted with @code{format} and @var{rest}.")
 {
   LY_ASSERT_TYPE (scm_is_string, str, 1);
   str = scm_simple_format (SCM_BOOL_F, str, rest);
@@ -289,7 +289,7 @@ LY_DEFINE (ly_string_percent_encode, "ly:string-percent-encode",
 
 LY_DEFINE (ly_number_2_string, "ly:number->string",
           1, 0, 0, (SCM s),
-          "Convert @var{num} to a string without generating many decimals.")
+          "Convert @var{s} to a string without generating many decimals.")
 {
   LY_ASSERT_TYPE (scm_is_number, s, 1);
 
@@ -574,8 +574,8 @@ format_single_argument (SCM arg, int precision, bool escape = false)
 
 LY_DEFINE (ly_format, "ly:format",
           1, 0, 1, (SCM str, SCM rest),
-          "LilyPond specific format, supporting @code{~a} and @code{~[0-9]f}. "
-          "Basic support for @code{~s} is also provided.")
+          "LilyPond specific format, supporting @code{~a} and @code{~[0-9]f}."
+          "  Basic support for @code{~s} is also provided.")
 {
   LY_ASSERT_TYPE (scm_is_string, str, 1);
 
@@ -644,7 +644,7 @@ LY_DEFINE (ly_format, "ly:format",
 
   if (scm_is_pair (rest))
     programming_error (string (__FUNCTION__)
-                      + ": too many  arguments");
+                      + ": too many arguments");
 
   vsize len = 0;
   for (vsize i = 0; i < results.size (); i++)