X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fstencil-scheme.cc;h=a092856a0a9ff47e6049ce81c10c8b34f6e02e9d;hb=64b22c2ebb52d0188fde41dc95832f2bc20c1147;hp=125b142d26fc46805b1734906989f999ff012c6e;hpb=b1e0e05b8ebcc86ff725baf8b41b022768e5881a;p=lilypond.git diff --git a/lily/stencil-scheme.cc b/lily/stencil-scheme.cc index 125b142d26..a092856a0a 100644 --- a/lily/stencil-scheme.cc +++ b/lily/stencil-scheme.cc @@ -18,7 +18,8 @@ LY_DEFINE (ly_stencil_translate_axis, "ly:stencil-translate-axis", 3, 0, 0, (SCM stil, SCM amount, SCM axis), - "Return a copy of @var{stil} but translated by @var{amount} in @var{axis} direction.") + "Return a copy of @var{stil} but translated by @var{amount}" + " in @var{axis} direction.") { Stencil *s = unsmob_stencil (stil); LY_ASSERT_SMOB (Stencil, stil, 1); @@ -35,8 +36,8 @@ LY_DEFINE (ly_stencil_translate_axis, "ly:stencil-translate-axis", LY_DEFINE (ly_stencil_translate, "ly:stencil-translate", 2, 0, 0, (SCM stil, SCM offset), - "Return a @var{stil}, " - "but translated by @var{offset} (a pair of numbers).") + "Return a @var{stil}, but translated by @var{offset}" + " (a pair of numbers).") { Stencil *s = unsmob_stencil (stil); LY_ASSERT_SMOB (Stencil, stil, 1); @@ -60,8 +61,9 @@ LY_DEFINE (ly_stencil_expr, "ly:stencil-expr", LY_DEFINE (ly_stencil_extent, "ly:stencil-extent", 2, 0, 0, (SCM stil, SCM axis), - "Return a pair of numbers signifying the extent of @var{stil} in " - "@var{axis} direction (0 or 1 for x and y axis respectively).") + "Return a pair of numbers signifying the extent of @var{stil} in" + " @var{axis} direction (@code{0} or @code{1} for x and" + " y@tie{}axis, respectively).") { Stencil *s = unsmob_stencil (stil); LY_ASSERT_SMOB (Stencil, stil, 1); @@ -72,7 +74,7 @@ LY_DEFINE (ly_stencil_extent, "ly:stencil-extent", LY_DEFINE (ly_stencil_empty_p, "ly:stencil-empty?", 1, 0, 0, (SCM stil), - "Return whether @var{stil} is empty ") + "Return whether @var{stil} is empty.") { Stencil *s = unsmob_stencil (stil); LY_ASSERT_SMOB (Stencil, stil, 1); @@ -84,13 +86,14 @@ LY_DEFINE (ly_stencil_combine_at_edge, "ly:stencil-combine-at-edge", SCM second, SCM padding, SCM minimum), - "Construct a stencil by putting @var{second} next to @var{first}. " - "@var{axis} can be 0 (x-axis) or 1 (y-axis), " - "@var{direction} can be -1 (left or down) or 1 (right or up). " - "The stencils are juxtaposed with @var{padding} as extra space. " - "If this puts the reference points closer than @var{minimum}, " - "they are moved by the latter amount." - "@var{first} and @var{second} may also be '() or #f.") + "Construct a stencil by putting @var{second} next to @var{first}." + " @var{axis} can be 0 (x-axis) or@tie{}1 (y-axis)." + " @var{direction} can be -1 (left or down) or@tie{}1 (right or" + " up). The stencils are juxtaposed with @var{padding} as extra" + " space. If this puts the reference points closer than" + " @var{minimum}, they are moved by the latter amount." + " @var{first} and @var{second} may also be @code{'()} or" + " @code{#f}.") { Stencil *s1 = unsmob_stencil (first); Stencil *s2 = unsmob_stencil (second); @@ -128,7 +131,7 @@ LY_DEFINE (ly_stencil_combine_at_edge, "ly:stencil-combine-at-edge", LY_DEFINE (ly_stencil_add, "ly:stencil-add", 0, 0, 1, (SCM args), - "Combine stencils. Takes any number of arguments.") + "Combine stencils. Takes any number of arguments.") { #define FUNC_NAME __FUNCTION__ SCM_VALIDATE_REST_ARGUMENT (args); @@ -156,22 +159,19 @@ LY_DEFINE (ly_stencil_add, "ly:stencil-add", LY_DEFINE (ly_make_stencil, "ly:make-stencil", 1, 2, 0, (SCM expr, SCM xext, SCM yext), - "Stencils are device independent output expressions. " - "They carry two pieces of information:\n" - + "Stencils are device independent output expressions." + " They carry two pieces of information:\n" + "\n" "@enumerate\n" - "@item\n" - "A specification of how to print this object. " - "This specification is processed by the output backends, " - "for example @file{scm/output-ps.scm}.\n" - + "A specification of how to print this object." + " This specification is processed by the output backends," + " for example @file{scm/output-ps.scm}.\n" + "\n" "@item\n" - "The vertical and horizontal extents of the object, " - "given as pairs. " - "If an extent is unspecified (or if you use " - "@code{(1000 . -1000)} as its value), it is taken to be empty.\n" - + "The vertical and horizontal extents of the object, given as" + " pairs. If an extent is unspecified (or if you use" + " @code{(1000 . -1000)} as its value), it is taken to be empty.\n" "@end enumerate\n") { SCM_ASSERT_TYPE (!scm_is_pair (expr) @@ -200,9 +200,9 @@ LY_DEFINE (ly_make_stencil, "ly:make-stencil", LY_DEFINE (ly_stencil_aligned_to, "ly:stencil-aligned-to", 3, 0, 0, (SCM stil, SCM axis, SCM dir), - "Align @var{stil} using its own extents. " - "@var{dir} is a number -1, 1 are left and right respectively. " - "Other values are interpolated (so 0 means the center).") + "Align @var{stil} using its own extents. @var{dir} is a number." + " @code{-1} and @code{1} are left and right, respectively." + " Other values are interpolated (so @code{0} means the center).") { LY_ASSERT_SMOB (Stencil, stil, 1); LY_ASSERT_TYPE (is_axis, axis, 2); @@ -217,7 +217,8 @@ LY_DEFINE (ly_stencil_aligned_to, "ly:stencil-aligned-to", LY_DEFINE (ly_stencil_fonts, "ly:stencil-fonts", 1, 0, 0, (SCM s), - " Analyse @var{s}, and return a list of fonts used in @var{s}.") + "Analyze @var{s}, and return a list of fonts used" + " in@tie{}@var{s}.") { LY_ASSERT_SMOB (Stencil, s, 1); Stencil *stil = unsmob_stencil (s); @@ -250,7 +251,8 @@ void stencil_interpret_in_scm (void *p, SCM expr) LY_DEFINE (ly_interpret_stencil_expression, "ly:interpret-stencil-expression", 4, 0, 0, (SCM expr, SCM func, SCM arg1, SCM offset), - "Parse EXPR, feed bits to FUNC with first arg ARG1") + "Parse @var{expr}, feed bits to @var{func} with first arg" + " @var{arg1} having offset @var{offset}.") { LY_ASSERT_TYPE (ly_is_procedure, func, 2); @@ -267,9 +269,10 @@ LY_DEFINE (ly_interpret_stencil_expression, "ly:interpret-stencil-expression", LY_DEFINE (ly_bracket, "ly:bracket", 4, 0, 0, (SCM a, SCM iv, SCM t, SCM p), - "Make a bracket in direction @var{a}. The extent of the bracket is " - "given by @var{iv}. The wings protude by an amount of @var{p}, which " - "may be negative. The thickness is given by @var{t}.") + "Make a bracket in direction@tie{}@var{a}. The extent of the" + " bracket is given by @var{iv}. The wings protude by an amount" + " of@tie{}@var{p}, which may be negative. The thickness is given" + " by@tie{}@var{t}.") { LY_ASSERT_TYPE (is_axis, a, 1); LY_ASSERT_TYPE (is_number_pair, iv, 2); @@ -284,7 +287,8 @@ LY_DEFINE (ly_bracket, "ly:bracket", LY_DEFINE (ly_stencil_rotate, "ly:stencil-rotate", 4, 0, 0, (SCM stil, SCM angle, SCM x, SCM y), - "Return a @var{stil} rotated @var{angle} degrees around point (@var{x}, @var{y}).") + "Return a stencil @var{stil} rotated @var{angle} degrees around" + " point (@var{x}, @var{y}).") { Stencil *s = unsmob_stencil (stil); LY_ASSERT_SMOB (Stencil, stil, 1); @@ -304,9 +308,8 @@ LY_DEFINE (ly_stencil_rotate, "ly:stencil-rotate", LY_DEFINE (ly_round_filled_box, "ly:round-filled-box", 3, 0, 0, (SCM xext, SCM yext, SCM blot), - "Make a @code{Stencil} " - "that prints a black box of dimensions @var{xext}, " - "@var{yext} and roundness @var{blot}.") + "Make a @code{Stencil} object that prints a black box of" + " dimensions @var{xext}, @var{yext} and roundness @var{blot}.") { LY_ASSERT_TYPE (is_number_pair, xext, 1); LY_ASSERT_TYPE (is_number_pair, yext, 2); @@ -319,7 +322,7 @@ LY_DEFINE (ly_round_filled_box, "ly:round-filled-box", LY_DEFINE (ly_register_stencil_expression, "ly:register-stencil-expression", 1, 0, 0, (SCM symbol), - "Add @var{symbol} as head of a stencil expression") + "Add @var{symbol} as head of a stencil expression.") { LY_ASSERT_TYPE (ly_is_symbol, symbol, 1); register_stencil_head (symbol);