Re: Document bound-details (sub-)properties in line-spanner-cc for IR (issue 560670043 by thomasmorle...@gmail.com)

[lemzwerg]

LGTM, thanks.  Only cosmetic nits :-)


https://codereview.appspot.com/560670043/diff/550690043/lily/line-spanner.cc
File lily/line-spanner.cc (right):

https://codereview.appspot.com/560670043/diff/550690043/lily/line-spanner.cc#newcode395
lily/line-spanner.cc:395: "Sets the Y-coordinate of the end point, in
staff-spaces"
I think this should rather be

  Sets the y@tie{}coordinate..., in staff spaces.

Ditto in other places.

https://codereview.appspot.com/560670043/diff/550690043/lily/line-spanner.cc#newcode398
lily/line-spanner.cc:398: " vertical center of the note head.\n"
The final `\n' here (and in similar places) in the middle of a paragraph
doesn't have any effect.  texinfo simply slurps it.  Only two `\n' in a
row to indicate a paragraph end are honored.

https://codereview.appspot.com/560670043/diff/550690043/lily/line-spanner.cc#newcode404
lily/line-spanner.cc:404: " So, a value of -1 (or LEFT) makes the line
start/end at"
... or @code{LEFT} ...

https://codereview.appspot.com/560670043/diff/550690043/lily/line-spanner.cc#newcode416
lily/line-spanner.cc:416: "@item stencil-offset\n"
@itemx stencil-offset\n

https://codereview.appspot.com/560670043/diff/550690043/lily/line-spanner.cc#newcode418
lily/line-spanner.cc:418: " end-point, centered on the line, as defined
by the X and"
end point, ... by the @code{X} and @code{Y} ...

https://codereview.appspot.com/560670043/diff/550690043/lily/line-spanner.cc#newcode420
lily/line-spanner.cc:420: " stencil-offset will move the symbol at the
edge vertically"
Setting either @code{...} or @code{...}

https://codereview.appspot.com/560670043/

___
lilypond-devel mailing list
lilypond-devel@gnu.org
https://lists.gnu.org/mailman/listinfo/lilypond-devel

Document bound-details (sub-)properties in line-spanner-cc for IR (issue 560670043 by thomasmorle...@gmail.com)

[thomasmorley65]

Reviewers: ,

Message:
Please review

Description:
Document bound-details (sub-)properties in line-spanner-cc for IR

Please review this at https://codereview.appspot.com/560670043/

Affected files (+44, -1 lines):
  M lily/line-spanner.cc


Index: lily/line-spanner.cc
diff --git a/lily/line-spanner.cc b/lily/line-spanner.cc
index  
a4b8343e739665efe752e56cc1f950d27739f6bc..04079d6416a1648a0b0c1170982e6188f0ffbab3  
100644

--- a/lily/line-spanner.cc
+++ b/lily/line-spanner.cc
@@ -382,7 +382,50 @@ Line_spanner::print (SCM smob)

 ADD_INTERFACE (Line_spanner,
"Generic line drawn between two objects, e.g., for use with"
-   " glissandi.",
+   " glissandi.\n"
+   "\n"
+   "@code{bound-details} is a nested alist.  It's possible to"
+   " specify settings for the sub-properties: @code{left},"
+   " @code{left-broken}, @code{right} and  
@code{right-broken}.\n"

+   "\n"
+   "Values for the following keys may be set:\n"
+   "\n"
+   "@table @code\n"
+   "@item Y\n"
+   "Sets the Y-coordinate of the end point, in staff-spaces"
+   " offset from the staff center line.  By default, it is the"
+   " center of the bound object, so a glissando points to the"
+   " vertical center of the note head.\n"
+   "For horizontal spanners, such as text spanners and"
+   " trill spanners, it is hardcoded to 0.\n"
+   "@item attach-dir\n"
+   "Determines where the line starts and ends in the"
+   " X-direction, relative to the bound object.\n"
+   " So, a value of -1 (or LEFT) makes the line start/end at"
+   " the left side of the note head it is attached to.\n"
+   "@item X\n"
+   "This is the absolute X-coordinate of the end point."
+   " Usually computed on the fly.\n"
+   "@item stencil\n"
+   "Line spanners may have symbols at the beginning or end,  
which"

+   " is contained in this sub-property.  For internal use.\n"
+   "@item text\n"
+   "This is a markup that is evaluated to yield the stencil.\n"
+   "@item stencil-align-dir-y\n"
+   "\n"
+   "@item stencil-offset\n"
+   "Without setting one of these, the stencil is simply put at  
the"

+   " end-point, centered on the line, as defined by the X and"
+   " Y sub-properties.  Setting either stencil-align-dir-y or"
+   " stencil-offset will move the symbol at the edge  
vertically"

+"relative to the end point of the line\n"
+   "@item arrow\n"
+   "Produces an arrowhead at the end-points of the line.\n"
+   "@item padding\n"
+   "Controls the space between the specified end point of the"
+   " line and the actual end.  Without padding, a glissando  
would"

+   " start and end in the center of each note head.\n"
+   "@end table\n",

/* properties */
"bound-details "



___
lilypond-devel mailing list
lilypond-devel@gnu.org
https://lists.gnu.org/mailman/listinfo/lilypond-devel