(grob-property-description 'align-dir dir? "Which side to align? -1: left side, 0: around center of width, 1: right side")
(grob-property-description 'alignment-done boolean? "boolean to administrate whether we've done the alignment already (to ensure that the process is done only once)")
(grob-property-description 'all-elements list? "list of all grobs in this line. Needed for protecting grobs from GC.")
-(grob-property-description 'arch-angle number? "")
-(grob-property-description 'arch-height number? "")
-(grob-property-description 'arch-thick number? "")
-(grob-property-description 'arch-width number? "")
-(grob-property-description 'arithmetic-basicspace number? "")
-(grob-property-description 'arithmetic-multiplier number? "see arithmetic-basicspace")
+(grob-property-description 'arch-angle number? "turning angle of the hook of a system brace" )
+(grob-property-description 'arch-height number? "height of the hook of a system brace")
+(grob-property-description 'arch-thick number? "thickness of the hook of system brace")
+(grob-property-description 'arch-width number? "width of the hook of a system brace")
+(grob-property-description 'arithmetic-basicspace number? "see @ref{spacing-spanner-interface}")
+(grob-property-description 'arithmetic-multiplier number? "see @ref{spacing-spanner-interface}")
(grob-property-description 'attachment pair? "cons of symbols, '(LEFT-TYPE . RIGHT-TYPE), where both types may be alongside-stem, stem, head or loose-end")
-(grob-property-description 'attachment-offset pair? "cons of offsets, '(LEFT-offset . RIGHT-offset). This offset is added to the attachments to prevent ugly slurs.")
-(grob-property-description 'axes list? "list of axis numbers. Should contain only one number.")
-(grob-property-description 'axes list? "list of axis (number) in which this group works")
-(grob-property-description 'bar-size number? "")
-(grob-property-description 'bars list? "list of barline ptrs.")
-(grob-property-description 'barsize-procedure procedure? "how to compute the size of a bar line")
+
+(grob-property-description 'attachment-offset pair? "cons of offsets,
+'(LEFT-offset . RIGHT-offset). This offset is added to the
+attachments to prevent ugly slurs. [fixme: we need more documentation here].
+")
+
+(grob-property-description 'axes list? "list of axis numbers.
+
+In the case of alignment grobs, this should contain only one number.")
+(grob-property-description 'bar-size number? "size of a bar line")
+(grob-property-description 'bars list? "list of barline pointers.")
+(grob-property-description 'barsize-procedure procedure? "Procedure that computes the size of a bar line.")
(grob-property-description 'bass list? " musical-pitch, optional")
(grob-property-description 'beam ly-grob? "pointer to the beam, if applicable")
(grob-property-description 'beam-space-function procedure? "function returning space given multiplicity")
(grob-property-description 'beam-thickness number? "thickness, measured in staffspace")
(grob-property-description 'beam-thickness number? "thickness, measured in staffspace")
(grob-property-description 'beam-width number? "width of the tremolo sign")
-(grob-property-description 'beam-width number? "width of the tremolo sign")
(grob-property-description 'beamed-lengths list? "list of stem lengths given beam multiplicity ")
(grob-property-description 'beamed-minimum-lengths list? "list of minimum stem lengths given beam multiplicity")
(grob-property-description 'beamed-stem-shorten number? "shorten beamed stems in forced direction")
to dump between two systems. Useful for forcing pagebreaks")
(grob-property-description 'bounded-by-me list? "list of spanners that have this
column as start/begin point. Only columns that have grobs or act as bounds are spaced.")
-(grob-property-description 'bracket-thick number? "")
-(grob-property-description 'bracket-width number? "")
+(grob-property-description 'bracket-thick number? "width of a system start bracket. ")
(grob-property-description 'break-align-symbol symbol? "the index in the spacing table (symbol) of the to be aligned item.")
(grob-property-description 'break-glyph-function procedure? "function taking glyph and break-direction, returning the glyph at a line break")
(grob-property-description 'breakable boolean? "boolean indicating if this is a breakable item (clef, barline, key sig, etc.)")
be at the center of the group after aligning (when using
Align_interface::center_on_element). ")
-(grob-property-description 'collapse-height number? "")
+(grob-property-description 'collapse-height number? "Minimum height of system start delimiter. If smaller, the delimiter is removed.")
(grob-property-description 'column-space-strength number? "relative strength of space following breakable columns (eg. prefatory matter)")
-(grob-property-description 'columns list? "list of paper-columns")
-(grob-property-description 'columns list? " list of note-columns.")
-(grob-property-description 'columns list? "list of all paper columns")
+(grob-property-description 'columns list? "list of grobs, typically containing paper-columns, list of note-columns")
(grob-property-description 'contains-grace boolean? "Used to widen entries for grace notes.")
-(grob-property-description 'control-points list? "List of 4 offsets (number-pairs) controlling the tie shape")
-(grob-property-description 'control-points list? "[internal] control points of bezier curve")
+(grob-property-description 'control-points list? "List of 4 offsets (number-pairs) that form control points for the tie/slur shape")
(grob-property-description 'damping integer? "amount of beam slope damping should beam slope be damped? 0: no, 1: yes, 100000: horizontal beams ")
-(grob-property-description 'damping number? "damping factor.")
(grob-property-description 'dash-length number? "the length of a dash")
(grob-property-description 'dash-period number? "the length of one dash + white space")
(grob-property-description 'dashed number? "[FIXME: use dash-period/dash length; see text-spanner] number representing the length of the dashes.")
(grob-property-description 'duration-log integer? "log of the duration, ie. 0=whole note, 1 = half note, etc.")
(grob-property-description 'edge-height pair? "a cons that specifies the heights of the vertical egdes '(LEFT-height . RIGHT-height)")
(grob-property-description 'edge-text pair? "a cons that specifies the texts to be set at the edges '(LEFT-text . RIGHT-text)")
-(grob-property-description 'elements list? " -- list of items.")
-(grob-property-description 'elements list? "list of grobs (NoteColumn,
-generally) participating in the collision. The
-@code{rest-collision} property in @code{elements} is set
-to a pointer to the collision")
-(grob-property-description 'elements list? "to be aligned grobs ")
+(grob-property-description 'elements list? "list of grobs, type depending on the Grob where this is set in.")
(grob-property-description 'expand-limit integer? "maximum number of measures expanded in church rests")
(grob-property-description 'extra-extent-X number-pair? "enlarge in X dimension by this much, measured in staff space")
(grob-property-description 'extra-extent-Y number-pair? "see @code{extra-extent-Y}")
(grob-property-description 'extra-offset number-pair? "pair of reals (a cons) forcing an extra offset before outputting")
-(grob-property-description 'extra-space number-pair? "pair of distances")
-(grob-property-description 'extra-space number-pair? "(cons LEFT RIGHT)")
+(grob-property-description 'extra-space number-pair? "pair of distances (cons LEFT RIGHT)")
(grob-property-description 'extremity-offset-alist list? "an alist (attachment stem-dir*dir slur-dir*dir) -> offset. The offset adds to the centre of the notehead, or stem.")
(grob-property-description 'extremity-rules list? "an alist (procedure
slur dir) -> attachment to determine the attachment (see above). If
procedure returns #t, attachment is used. Otherwise, the next
procedure is tried.")
-(grob-property-description 'flag-style string? "")
-(grob-property-description 'flag-width-function procedure? "")
+(grob-property-description 'flag-style string? "style for flag (hook of a stem)")
+(grob-property-description 'flag-width-function procedure? "Procedure that computes the width of a half-beam (a non-connecting beam.).")
(grob-property-description 'font-family symbol? "partial font
definition: music roman braces dynamic math ...")
(grob-property-description 'font-name symbol? "partial font definition:
base name of font file FIXME: should override other partials")
(grob-property-description 'font-point-size number? "partial font definition: exact font size in points FIXME: should override font-relative-size")
-(grob-property-description 'font-relative-size number? "partial font definition: the relative size, 0 is style-sheet's normal size, -1 is smaller, +1 is bigger")
-(grob-property-description 'font-relative-size integer? "")
+(grob-property-description 'font-relative-size number? "partial font definition: the relative size compared the `normal' size.
+ 0 is style-sheet's normal size, -1 is smaller, +1 is bigger, -1 is smaller")
(grob-property-description 'font-series symbol? "partial font definition: medium, bold")
(grob-property-description 'font-shape symbol? "partial font definition: upright or italic")
collision_note_width that overides automatic collision settings. This
is used by @ref{note-collision-interface}")
-(grob-property-description 'fraction number-pair? "")
+(grob-property-description 'fraction number-pair? "fraction of a time signature.")
(grob-property-description 'full-size-change boolean? "if set, don't make a change clef smaller.")
(grob-property-description 'glyph symbol? "a string determining what (style) of glyph is typeset. Valid choices depend on the function that is reading this property. ")
-(grob-property-description 'gap number? "Size of a gap in a variable symbol")
(grob-property-description 'glyph-name string? "a name of character within font")
+(grob-property-description 'gap number? "Size of a gap in a variable symbol")
+
(grob-property-description 'grow-direction dir? "crescendo or decrescendo?")
(grob-property-description 'hair-thickness number? "thickness, measured in stafflinethickness")
-(grob-property-description 'heads pair? "pair of grob pointers, pointing to the two heads of the tie. ")
-(grob-property-description 'heads list? "list of note heads")
+(grob-property-description 'heads pair? "list of note heads,
+
+FIXME: in Tie this is a pair of grob pointers, pointing to the two heads of the tie.
+
+")
(grob-property-description 'height number? "in staffspace ")
-(grob-property-description 'height-hs number? "in halfspace. Only used by Beam.")
+(grob-property-description 'height-hs number? "in halfspace. Only used by Beam.") ; Remove-me
(grob-property-description 'height-quants procedure? "function of type (beam staff-line-thickness) -> list of quants. Default value: default-beam-dy-quants.
")
(grob-property-description 'horizontal-shift integer? "integer that identifies ranking of note-column for horizontal shifting. This is used by @ref{note-collision-interface}")
(grob-property-description 'interfaces list? "list of symbols indicating the interfaces supported by this object. Is initialized from the @code{meta} field.")
(grob-property-description 'inversion list? " musical-pitch, optional")
(grob-property-description 'items-worth-living list? "list of interesting items. If empty in a particular system, clear that system.")
-(grob-property-description 'kern number? "amount of extra white space to add before text. This is `relative'(?) to the current alignment.")
-(grob-property-description 'kern number? "space after a thick line")
+(grob-property-description 'kern number? "amount of extra white space to add.
+
+For text, this is `relative'(?) to the current alignment.
+
+For barline, space after a thick line")
(grob-property-description 'left-padding number? "space left of accs")
(grob-property-description 'length number? "Stem length for unbeamed stems, only for user override")
(grob-property-description 'lengths list? "Stem length given multiplicity of flag")
(grob-property-description 'minimum-distances list? "list of rods (ie. (OBJ . DIST) pairs)")
(grob-property-description 'minimum-extent-X number-pair? "minimum size in X dimension, measured in staff space")
(grob-property-description 'minimum-extent-Y number-pair? "see @code{minimum-extent-Y}")
-(grob-property-description 'minimum-length number? "minimum length in staffspace")
-
(grob-property-description 'minimum-length number? "try to make the
-hyphens at least this long. Also works as a scaling parameter for the
-length")
+Grob at least this long.
+
+Also works as a scaling parameter for the length of hyphen. ")
;; FIXME.
(grob-property-description 'minimum-space number-pair? "(cons LEFT RIGHT)")
(grob-property-description 'minimum-space number? "minimum distance that the victim should move (after padding)")
-
(grob-property-description 'minimum-width number? "minimum-width of rest symbol, in staffspace")
(grob-property-description 'molecule-callback procedure? "Function taking grob as argument, returning a Scheme encoded Molecule.")
(grob-property-description 'new-accidentals list? "list of (pitch, accidental) pairs")
(grob-property-description 'no-stem-extend boolean? "should stem not be extended to middle staff line?")
(grob-property-description 'non-default boolean? "not set because of existence of a bar?")
(grob-property-description 'note-width number? "unit for horizontal translation, measured in staff-space.")
-(grob-property-description 'number-gap number? "")
+(grob-property-description 'number-gap number? "size of the gap for the number in a tuplet.")
(grob-property-description 'old-accidentals list? "list of (pitch, accidental) pairs")
(grob-property-description 'origin ly-input-location? "location in input file of the definition")
(grob-property-description 'outer-stem-length-limit number? "catch
more than this (in staffspace)")
(grob-property-description 'padding number? "add this much extra space between objects that are next to each other")
-
(grob-property-description 'parallel-beam boolean? "internal: true if there is a beam just as wide as the bracket ")
(grob-property-description 'pitches list? "list of musical-pitch")
(grob-property-description 'raise number? "height for text to be raised (a negative value lowers the text")
(grob-property-description 'right-padding number? "space right of accs")
-(grob-property-description 'right-trim-amount number? "")
+(grob-property-description 'right-trim-amount number? "shortening of the lyric extender on the right")
(grob-property-description 'script-priority number? "A sorting key that determines in what order a script is within a stack of scripts")
(grob-property-description 'self-alignment-X number? "real number: -1 =
left aligned, 0 = center, 1 right-aligned in X direction.
(grob-property-description 'stacking-dir dir? "stack contents of grobs in which direction ?")
(grob-property-description 'staff-space number? "Amount of line leading relative to global staffspace")
(grob-property-description 'staffline-clearance number? "don't get closer than this to stafflines.")
-(grob-property-description 'stem ly-grob? "pointer to the stem object.")
(grob-property-description 'stem ly-grob? "pointer to Stem object")
(grob-property-description 'stem-centered boolean? "Center stems on note heads. Useful for mensural notation")
(grob-property-description 'stem-end-position number? "Where does the stem end (the end is opposite to the support-head")
(grob-property-description 'x-gap number? "horizontal gap between notehead and tie")
(grob-property-description 'y-free number? "minimal vertical gap between slur and noteheads or stems")
(grob-property-description 'y-position number? "position of left edge")
-(grob-property-description 'y-position-hs number? "in half space, position of left edge. Only used by Beam.")
+(grob-property-description 'y-position-hs number? "in half space, position of left edge. Only used by Beam.") ;FXIME
projects / lilypond.git / blobdiff