From: Werner Lemberg Date: Tue, 26 Oct 2010 06:57:45 +0000 (+0200) Subject: Minor documentation improvements for Scheme functions. X-Git-Tag: release/2.13.38-1~16 X-Git-Url: https://git.donarmstrong.com/?p=lilypond.git;a=commitdiff_plain;h=d3a2630aa49f808124d5adf4030d8ddcc3212985 Minor documentation improvements for Scheme functions. --- diff --git a/lily/axis-group-interface-scheme.cc b/lily/axis-group-interface-scheme.cc index 37a7ed3238..f15c4636ab 100644 --- a/lily/axis-group-interface-scheme.cc +++ b/lily/axis-group-interface-scheme.cc @@ -49,7 +49,7 @@ LY_DEFINE (ly_relative_group_extent, "ly:relative-group-extent", LY_DEFINE (ly_axis_group_interface__add_element, "ly:axis-group-interface::add-element", 2, 0, 0, (SCM grob, SCM grob_element), "Set @var{grob} the parent of @var{grob-element} on all axes of" - "@var{grob}.") + " @var{grob}.") { LY_ASSERT_SMOB (Grob, grob, 1); LY_ASSERT_SMOB (Grob, grob_element, 2); diff --git a/lily/book-scheme.cc b/lily/book-scheme.cc index 28ad90cd44..a10b39e36a 100644 --- a/lily/book-scheme.cc +++ b/lily/book-scheme.cc @@ -122,7 +122,7 @@ LY_DEFINE (ly_book_add_score_x, "ly:book-add-score!", LY_DEFINE (ly_book_add_bookpart_x, "ly:book-add-bookpart!", 2, 0, 0, (SCM book_smob, SCM book_part), - "Add @var{book_part} to @var{book-smob} book part list.") + "Add @var{book-part} to @var{book-smob} book part list.") { LY_ASSERT_SMOB (Book, book_smob, 1); Book *book = unsmob_book (book_smob); @@ -132,7 +132,7 @@ LY_DEFINE (ly_book_add_bookpart_x, "ly:book-add-bookpart!", LY_DEFINE (ly_book_book_parts, "ly:book-book-parts", 1, 0, 0, (SCM book), - "Return book parts in book.") + "Return book parts in @var{book}.") { LY_ASSERT_SMOB (Book, book, 1); Book *b = unsmob_book (book); @@ -141,7 +141,7 @@ LY_DEFINE (ly_book_book_parts, "ly:book-book-parts", LY_DEFINE (ly_book_paper, "ly:book-paper", 1, 0, 0, (SCM book), - "Return paper in book.") + "Return paper in @var{book}.") { LY_ASSERT_SMOB (Book, book, 1); Book *b = unsmob_book (book); @@ -150,7 +150,7 @@ LY_DEFINE (ly_book_paper, "ly:book-paper", LY_DEFINE (ly_book_scores, "ly:book-scores", 1, 0, 0, (SCM book), - "Return scores in book.") + "Return scores in @var{book}.") { LY_ASSERT_SMOB (Book, book, 1); Book *b = unsmob_book (book); diff --git a/lily/context-scheme.cc b/lily/context-scheme.cc index 8f43236d86..c18dc911f7 100644 --- a/lily/context-scheme.cc +++ b/lily/context-scheme.cc @@ -37,7 +37,7 @@ LY_DEFINE (ly_context_current_moment, LY_DEFINE (ly_context_id, "ly:context-id", 1, 0, 0, (SCM context), "Return the ID string of @var{context}," - " i.e., for @code{\\context Voice = one @dots{}}" + " i.e., for @code{\\context Voice = \"one\" @dots{}}" " return the string @code{one}.") { Context *tr = unsmob_context (context); @@ -50,7 +50,7 @@ LY_DEFINE (ly_context_id, "ly:context-id", LY_DEFINE (ly_context_name, "ly:context-name", 1, 0, 0, (SCM context), "Return the name of @var{context}," - " i.e., for @code{\\context Voice = one @dots{}}" + " i.e., for @code{\\context Voice = \"one\" @dots{}}" " return the symbol @code{Voice}.") { LY_ASSERT_SMOB (Context, context, 1); diff --git a/lily/general-scheme.cc b/lily/general-scheme.cc index 53b0564ceb..8359e8fc5b 100644 --- a/lily/general-scheme.cc +++ b/lily/general-scheme.cc @@ -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); diff --git a/lily/global-context-scheme.cc b/lily/global-context-scheme.cc index 4b525e8253..0fdf125624 100644 --- a/lily/global-context-scheme.cc +++ b/lily/global-context-scheme.cc @@ -65,7 +65,7 @@ LY_DEFINE (ly_make_global_translator, "ly:make-global-translator", LY_DEFINE (ly_make_global_context, "ly:make-global-context", 1, 0, 0, (SCM output_def), "Set up a global interpretation context, using the output" - " block @var{output_def}. The context is returned.") + " block @var{output-def}. The context is returned.") { LY_ASSERT_SMOB (Output_def, output_def, 1); Output_def *odef = unsmob_output_def (output_def); diff --git a/lily/grob-scheme.cc b/lily/grob-scheme.cc index c27a9ee8bd..052d952a6f 100644 --- a/lily/grob-scheme.cc +++ b/lily/grob-scheme.cc @@ -111,9 +111,9 @@ LY_DEFINE (ly_grob_interfaces, "ly:grob-interfaces", LY_DEFINE (ly_grob_object, "ly:grob-object", 2, 0, 0, (SCM grob, SCM sym), - "Return the value of a pointer in grob@tie{}@var{g} of property" + "Return the value of a pointer in grob @var{grob} of property" " @var{sym}. It returns @code{'()} (end-of-list) if @var{sym}" - " is undefined in@tie{}@var{g}.") + " is undefined in @var{grob}.") { Grob *sc = unsmob_grob (grob); @@ -337,7 +337,7 @@ LY_DEFINE (ly_grob_suicide_x, "ly:grob-suicide!", LY_DEFINE (ly_grob_translate_axis_x, "ly:grob-translate-axis!", 3, 0, 0, (SCM grob, SCM d, SCM a), - "Translate @var{g} on axis@tie{}@var{a} over" + "Translate @var{grob} on axis@tie{}@var{a} over" " distance@tie{}@var{d}.") { Grob *me = unsmob_grob (grob); @@ -352,7 +352,7 @@ LY_DEFINE (ly_grob_translate_axis_x, "ly:grob-translate-axis!", LY_DEFINE (ly_grob_default_font, "ly:grob-default-font", 1, 0, 0, (SCM grob), - "Return the default font for grob @var{gr}.") + "Return the default font for grob @var{grob}.") { Grob *gr = unsmob_grob (grob); diff --git a/lily/note-column-scheme.cc b/lily/note-column-scheme.cc index e8b88af1e9..5fc7974ade 100644 --- a/lily/note-column-scheme.cc +++ b/lily/note-column-scheme.cc @@ -23,8 +23,8 @@ LY_DEFINE (ly_note_column_accidentals, "ly:note-column-accidentals", 1, 0, 0, (SCM note_column), - "Return the @code{AccidentalPlacement} grob from @var{note_column}" - "if any, or @code{SCM_EOL} otherwise.") + "Return the @code{AccidentalPlacement} grob from @var{note-column}" + " if any, or @code{SCM_EOL} otherwise.") { Grob *grob = unsmob_grob (note_column); LY_ASSERT_SMOB (Grob, note_column, 1); @@ -36,8 +36,8 @@ LY_DEFINE (ly_note_column_accidentals, "ly:note-column-accidentals", LY_DEFINE (ly_note_column_dot_column, "ly:note-column-dot-column", 1, 0, 0, (SCM note_column), - "Return the @code{DotColumn} grob from @var{note_column}" - "if any, or @code{SCM_EOL} otherwise.") + "Return the @code{DotColumn} grob from @var{note-column}" + " if any, or @code{SCM_EOL} otherwise.") { Grob *grob = unsmob_grob (note_column); LY_ASSERT_SMOB (Grob, note_column, 1); diff --git a/lily/page-marker-scheme.cc b/lily/page-marker-scheme.cc index 670d096158..d4eac29d2d 100644 --- a/lily/page-marker-scheme.cc +++ b/lily/page-marker-scheme.cc @@ -33,7 +33,7 @@ LY_DEFINE (ly_make_page_permission_marker, "ly:make-page-permission-marker", LY_DEFINE (ly_make_page_label_marker, "ly:make-page-label-marker", 1, 0, 0, (SCM label), - "Return page marker with label.") + "Return page marker with label @var{label}.") { LY_ASSERT_TYPE (ly_is_symbol, label, 1); Page_marker *page_marker = new Page_marker (); diff --git a/lily/pfb-scheme.cc b/lily/pfb-scheme.cc index 730442ef05..89666192a3 100644 --- a/lily/pfb-scheme.cc +++ b/lily/pfb-scheme.cc @@ -8,7 +8,8 @@ LY_DEFINE (ly_pfb_2_pfa, "ly:pfb->pfa", 1, 0, 0, (SCM pfb_file_name), - "Convert the contents of a PFB file to PFA.") + "Convert the contents of a Type@tie{}1 font in PFB format" + " to PFA format.") { LY_ASSERT_TYPE (scm_is_string, pfb_file_name, 1); diff --git a/lily/prob-scheme.cc b/lily/prob-scheme.cc index 119688e157..f54769df4c 100644 --- a/lily/prob-scheme.cc +++ b/lily/prob-scheme.cc @@ -36,7 +36,7 @@ LY_DEFINE (ly_prob_set_property_x, "ly:prob-set-property!", */ LY_DEFINE (ly_prob_property_p, "ly:prob-property?", 2, 1, 0, (SCM obj, SCM sym), - "Is boolean prop @var{sym} set?") + "Is boolean prop @var{sym} of @var{sym} set?") { return scm_equal_p (SCM_BOOL_T, ly_prob_property (obj, sym, SCM_BOOL_F)); } @@ -103,7 +103,7 @@ LY_DEFINE (ly_prob_mutable_properties, "ly:prob-mutable-properties", LY_DEFINE (ly_prob_immutable_properties, "ly:prob-immutable-properties", 1, 0, 0, (SCM prob), - "Retrieve an alist of mutable properties.") + "Retrieve an alist of immutable properties.") { LY_ASSERT_SMOB (Prob, prob, 1); Prob *ps = unsmob_prob (prob); diff --git a/lily/score-scheme.cc b/lily/score-scheme.cc index 0fd7be0d6f..fe08bef253 100644 --- a/lily/score-scheme.cc +++ b/lily/score-scheme.cc @@ -29,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); diff --git a/lily/simple-closure.cc b/lily/simple-closure.cc index ddf39efdcf..48d2dab57b 100644 --- a/lily/simple-closure.cc +++ b/lily/simple-closure.cc @@ -104,7 +104,7 @@ LY_DEFINE (ly_simple_closure_p, "ly:simple-closure?", 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} @dots{})}, and will be" + " @code{(@var{func} @var{a1} @var{a2} @dots{})}, and will be" " invoked as @code{(@var{func} @var{delayed-arg} @var{a1}" " @var{a2} @dots{})}.") {