From: Werner Lemberg Date: Thu, 13 Mar 2008 23:59:06 +0000 (+0100) Subject: ADD_INTERFACE: Formatting and fixing typos. X-Git-Tag: release/2.11.43-1~40^2^2~7 X-Git-Url: https://git.donarmstrong.com/?a=commitdiff_plain;h=6fb6249345ce846c8c55f843b21c6e85024a720b;p=lilypond.git ADD_INTERFACE: Formatting and fixing typos. --- diff --git a/lily/accidental.cc b/lily/accidental.cc index 402a17e99d..09ae8bfae9 100644 --- a/lily/accidental.cc +++ b/lily/accidental.cc @@ -212,7 +212,7 @@ Accidental_interface::get_stencil (Grob *me) ADD_INTERFACE (Accidental_interface, - "a single accidental", + "A single accidental.", /* props */ "alteration " diff --git a/lily/align-interface.cc b/lily/align-interface.cc index db71c32b8f..a67cfbcb7f 100644 --- a/lily/align-interface.cc +++ b/lily/align-interface.cc @@ -399,18 +399,16 @@ Align_interface::calc_max_stretch (SCM smob) } ADD_INTERFACE (Align_interface, + "Order grobs from top to bottom, left to right, right to left " + "or bottom to top. For vertical alignments of staves, the " + "@code{break-system-details} of the left " + "@internalsref{NonMusicalPaperColumn} may be set to tune " + "vertical spacing. Set @code{alignment-extra-space} to add " + "extra space for staves. Set " + "@code{fixed-alignment-extra-space} to force staves in " + "@code{PianoStaff}s further apart.", - "Order grobs from top to bottom, left to right, right to left or bottom " - "to top. " - "For vertical alignments of staves, the @code{break-system-details} of " - "the left @internalsref{NonMusicalPaperColumn} may be set to tune vertical spacing " - "Set @code{alignment-extra-space} to add extra space for staves. Set " - "@code{fixed-alignment-extra-space} to force staves in PianoStaves further apart." - , - - /* - properties - */ + /* properties */ "align-dir " "axes " "elements " diff --git a/lily/ambitus.cc b/lily/ambitus.cc index a584834f49..62583aa6fb 100644 --- a/lily/ambitus.cc +++ b/lily/ambitus.cc @@ -68,7 +68,7 @@ Ambitus::print (SCM smob) return SCM_EOL; } -ADD_INTERFACE (Ambitus , +ADD_INTERFACE (Ambitus, "The line between note heads for a pitch range.", /* props */ diff --git a/lily/arpeggio.cc b/lily/arpeggio.cc index 5322a46c95..0aef5c10ec 100644 --- a/lily/arpeggio.cc +++ b/lily/arpeggio.cc @@ -169,7 +169,8 @@ Arpeggio::pure_height (SCM smob, SCM, SCM) } ADD_INTERFACE (Arpeggio, - "Functions and settings for drawing an arpeggio symbol (a wavy line left to noteheads.", + "Functions and settings for drawing an arpeggio symbol (a " + "wavy line left to noteheads.", /* properties */ "arpeggio-direction " diff --git a/lily/axis-group-interface.cc b/lily/axis-group-interface.cc index 0a82fe6713..8f8e1b8893 100644 --- a/lily/axis-group-interface.cc +++ b/lily/axis-group-interface.cc @@ -628,7 +628,6 @@ Axis_group_interface::print (SCM smob) } ADD_INTERFACE (Axis_group_interface, - "An object that groups other layout objects.", /* properties */ diff --git a/lily/balloon.cc b/lily/balloon.cc index afaaad8e37..fa24ba913d 100644 --- a/lily/balloon.cc +++ b/lily/balloon.cc @@ -70,7 +70,8 @@ Balloon_interface::print (SCM smob) } ADD_INTERFACE (Balloon_interface, - "A collection of routines to put text balloons around an object.", + "A collection of routines to put text balloons around an " + "object.", /* properties */ "padding " diff --git a/lily/bar-line.cc b/lily/bar-line.cc index a0fa5587b4..80c5e94f30 100644 --- a/lily/bar-line.cc +++ b/lily/bar-line.cc @@ -291,30 +291,26 @@ Bar_line::calc_anchor (SCM smob) } ADD_INTERFACE (Bar_line, - "Bar line.\n" "\n" - "Print a special bar symbol. It replaces the \n" - "regular bar symbol with a special\n" - "symbol. The argument @var{bartype} is a string which specifies the\n" - "kind of bar to print. Options are @code{:|}, \n" - "@code{|:}, @code{:|:},\n" - "@code{||}, @code{|.},\n" - "@code{.|}, and @code{.|.}. \n" + "Print a special bar symbol. It replaces the regular bar " + "symbol with a special symbol. The argument @var{bartype} " + "is a string which specifies the kind of bar to print. " + "Options are @code{:|}, @code{|:}, @code{:|:}, @code{||}, " + "@code{|.}, @code{.|}, and @code{.|.}.\n" "\n" - "These produce, respectively, a right repeat, a left repeat, a double\n" - "repeat, a double bar, a start bar, an end bar, and a thick double bar.\n" - "In addition, there is an option @code{||:} which is equivalent to\n" - "@code{|:} except at line breaks, where it produces a double bar (@code{||})\n" - "at the end of the line and a repeat sign (@code{|:}) at the beginning\n" - "of the new line." - "If @var{bartype} is set to @code{empty} then nothing is printed,\n" - "but a line break is allowed at that spot.\n" - "\n\n" - "@code{gap} is used for the gaps in dashed barlines." - - , - + "These produce, respectively, a right repeat, a left repeat, " + "a double repeat, a double bar, a start bar, an end bar, and " + "a thick double bar. In addition, there is an option " + "@code{||:} which is equivalent to @code{|:} except at line " + "breaks, where it produces a double bar (@code{||}) at the " + "end of the line and a repeat sign (@code{|:}) at the " + "beginning of the new line.\n" + "\n" + "If @var{bartype} is set to @code{empty} then nothing is " + "printed, but a line break is allowed at that spot.\n" + "\n" + "@code{gap} is used for the gaps in dashed barlines.", /* properties */ "allow-span-bar " diff --git a/lily/beam.cc b/lily/beam.cc index 3214fe4193..147b3f01f0 100644 --- a/lily/beam.cc +++ b/lily/beam.cc @@ -1523,14 +1523,12 @@ Beam::get_direction_beam_count (Grob *me, Direction d) } ADD_INTERFACE (Beam, - - "A beam. \n\n" + "A beam.\n" + "\n" "The @code{thickness} property is the weight of beams, " - "measured in staffspace. The @code{direction} " - "property is not user-serviceable. Use " - "the @code{direction} property of @code{Stem} instead. " - - , + "measured in staffspace. The @code{direction} property is " + "not user-serviceable. Use the @code{direction} property " + "of @code{Stem} instead.", /* properties */ "annotation " diff --git a/lily/break-alignment-interface.cc b/lily/break-alignment-interface.cc index bfaeccea22..06c34a6251 100644 --- a/lily/break-alignment-interface.cc +++ b/lily/break-alignment-interface.cc @@ -366,37 +366,38 @@ Break_aligned_interface::calc_break_visibility (SCM smob) } ADD_INTERFACE (Break_alignable_interface, - "Object that is aligned on a break aligment. ", + "Object that is aligned on a break aligment.", /* properties */ "break-align-symbols " - ) - - + ); ADD_INTERFACE (Break_aligned_interface, "Items that are aligned in prefatory matter.\n" "\n" - "The spacing of these items is controlled by the @code{space-alist}\n" - "property. It contains a list @code{break-align-symbol}s with a specification\n" - "of the associated space. The space specification can be " + "The spacing of these items is controlled by the " + "@code{space-alist} property. It contains a list " + "@code{break-align-symbol}s with a specification of the " + "associated space. The space specification can be\n" + "\n" "@table @code\n" "@item (minimum-space . @var{spc}))\n" - " Pad space until the distance is @var{spc}\n" + " Pad space until the distance is @var{spc}.\n" "@item (fixed-space . @var{spc})\n" - " Set a fixed space\n" + " Set a fixed space.\n" "@item (semi-fixed-space . @var{spc})\n" - " Set a space. Half of it is fixed and half is stretchable. \n" - "(does not work at start of line. fixme)\n" + " Set a space. Half of it is fixed and half is stretchable. " + " (does not work at start of line. fixme)\n" "@item (extra-space . @var{spc})\n" " Add @var{spc} amount of space.\n" "@end table\n" "\n" - "Special keys for the alist are @code{first-note} and @code{next-note}, signifying\n" - "the first note on a line, and the next note halfway a line.\n" + "Special keys for the alist are @code{first-note} and " + "@code{next-note}, signifying the first note on a line, and " + "the next note halfway a line.\n" "\n" - "Rules for this spacing are much more complicated than this. \n" - "See [Wanske] page 126 -- 134, [Ross] pg 143 -- 147\n", + "Rules for this spacing are much more complicated than this. " + "See [Wanske] page 126--134, [Ross] page 143--147.", /* properties */ "break-align-anchor " @@ -406,8 +407,10 @@ ADD_INTERFACE (Break_aligned_interface, ); ADD_INTERFACE (Break_alignment_interface, - "The object that performs break aligment. See @ref{break-aligned-interface}.", + "The object that performs break aligment. " + "See @ref{break-aligned-interface}.", /* properties */ "positioning-done " - "break-align-orders"); + "break-align-orders " + ); diff --git a/lily/breathing-sign.cc b/lily/breathing-sign.cc index 3c32a766d2..7c605c4b19 100644 --- a/lily/breathing-sign.cc +++ b/lily/breathing-sign.cc @@ -177,6 +177,6 @@ Breathing_sign::offset_callback (SCM smob) ADD_INTERFACE (Breathing_sign, "A breathing sign.", + /* properties */ "direction " - ); diff --git a/lily/chord-name.cc b/lily/chord-name.cc index 757a1a5783..3ffc591bd8 100644 --- a/lily/chord-name.cc +++ b/lily/chord-name.cc @@ -35,5 +35,6 @@ Chord_name::after_line_breaking (SCM smob) ADD_INTERFACE (Chord_name, "A chord name.", - - "begin-of-line-visible"); + /* properties */ + "begin-of-line-visible " + ); diff --git a/lily/clef.cc b/lily/clef.cc index 90b5480087..166956052a 100644 --- a/lily/clef.cc +++ b/lily/clef.cc @@ -56,7 +56,7 @@ Clef::print (SCM smob) } ADD_INTERFACE (Clef, - "A clef sign", + "A clef sign.", /* properties */ "full-size-change " diff --git a/lily/cluster.cc b/lily/cluster.cc index c4b11b38c5..8d18406c03 100644 --- a/lily/cluster.cc +++ b/lily/cluster.cc @@ -198,15 +198,17 @@ Cluster::print (SCM smob) } ADD_INTERFACE (Cluster, - "A graphically drawn musical cluster. " - "\n\n" - "@code{padding} adds to the vertical extent of the shape (top and " - "bottom). \n\n" - "The property @code{style} controls the shape of cluster segments. Valid values " - "include @code{leftsided-stairs}, @code{rightsided-stairs}, @code{centered-stairs}, " - "and @code{ramp}.\n", - - /* props */ + "A graphically drawn musical cluster.\n" + "\n" + "@code{padding} adds to the vertical extent of the shape (top " + "and bottom).\n" + "\n" + "The property @code{style} controls the shape of cluster " + "segments. Valid values include @code{leftsided-stairs}, " + "@code{rightsided-stairs}, @code{centered-stairs}, and " + "@code{ramp}.\n", + + /* properties */ "style " "padding " "columns " @@ -230,8 +232,10 @@ Cluster_beacon::height (SCM g) } ADD_INTERFACE (Cluster_beacon, - "A place holder for the cluster spanner to determine the vertical " - "extents of a cluster spanner at this X position.", + "A place holder for the cluster spanner to determine the " + "vertical extents of a cluster spanner at this " + "X@tie{}position.", /* properties */ - "positions "); + "positions " + ); diff --git a/lily/custos.cc b/lily/custos.cc index 92ea11c435..70850a2c27 100644 --- a/lily/custos.cc +++ b/lily/custos.cc @@ -83,10 +83,11 @@ Custos::print (SCM smob) ADD_INTERFACE (Custos, "A custos object. @code{style} can have four valid values: " - "mensural, vaticana, medicaea and hufnagel. Mensural is the " - "default style. ", + "@code{mensural}, @code{vaticana}, @code{medicaea}, and " + "@code{hufnagel}. @code{mensural} is the default style.", /* properties */ "style " "neutral-position " - "neutral-direction "); + "neutral-direction " + ); diff --git a/lily/dot-column.cc b/lily/dot-column.cc index 1698ef51eb..fc4ec01be3 100644 --- a/lily/dot-column.cc +++ b/lily/dot-column.cc @@ -201,9 +201,8 @@ Dot_column::add_head (Grob *me, Grob *rh) } ADD_INTERFACE (Dot_column, - - "Groups dot objects so they form a column, and position dots so they do not " - "clash with staff lines. ", + "Group dot objects so they form a column, and position " + "dots so they do not clash with staff lines.", /* properties */ "dots " diff --git a/lily/dots.cc b/lily/dots.cc index cb46d269a0..d740ecd765 100644 --- a/lily/dots.cc +++ b/lily/dots.cc @@ -59,11 +59,11 @@ Dots::print (SCM d) } ADD_INTERFACE (Dots, - "The dots to go with a notehead or rest." - "@code{direction} sets the preferred direction to move in case of staff " - "line collisions. @code{style} defaults to undefined, which is " - "normal 19th/20th century traditional style. Set @code{style} " - "to @code{vaticana} for ancient type dots. ", + "The dots to go with a notehead or rest. @code{direction} " + "sets the preferred direction to move in case of staff line " + "collisions. @code{style} defaults to undefined, which is " + "normal 19th/20th century traditional style. Set " + "@code{style} to @code{vaticana} for ancient type dots.", /* properties */ "direction " diff --git a/lily/enclosing-bracket.cc b/lily/enclosing-bracket.cc index 61462de17a..e16a8e9bbc 100644 --- a/lily/enclosing-bracket.cc +++ b/lily/enclosing-bracket.cc @@ -24,10 +24,9 @@ public: ADD_INTERFACE (Enclosing_bracket, - "Brackets alongside bass figures.", - /* props */ + /* properties */ "bracket-flare " "edge-height " "elements " diff --git a/lily/figured-bass-continuation.cc b/lily/figured-bass-continuation.cc index 16d60a5f53..389e4e96ac 100644 --- a/lily/figured-bass-continuation.cc +++ b/lily/figured-bass-continuation.cc @@ -83,7 +83,7 @@ Figured_bass_continuation::print (SCM grob) ADD_INTERFACE (Figured_bass_continuation, "Simple extender line between bounds.", - /* props */ + /* properties */ "thickness " "padding " "figures " diff --git a/lily/font-interface.cc b/lily/font-interface.cc index 5dc2129c14..1990dccb7b 100644 --- a/lily/font-interface.cc +++ b/lily/font-interface.cc @@ -51,8 +51,9 @@ Font_interface::text_font_alist_chain (Grob *g) ADD_INTERFACE (Font_interface, "Any symbol that is typeset through fixed sets of glyphs, " - " (ie. fonts)", + "(i.e., fonts).", + /* properties */ "font " "font-encoding " "font-family " diff --git a/lily/gregorian-ligature.cc b/lily/gregorian-ligature.cc index 0bfdde3efa..c9b849eed9 100644 --- a/lily/gregorian-ligature.cc +++ b/lily/gregorian-ligature.cc @@ -49,7 +49,21 @@ Gregorian_ligature::prefixes_to_str (Grob *primitive) read by the associated item class, such as VaticanaLigature.--jr */ ADD_INTERFACE (Gregorian_ligature, - "A gregorian ligature", - "virga stropha inclinatum auctum descendens ascendens " - "oriscus quilisma deminutum cavum linea pes-or-flexa " - "context-info prefix-set"); + "A gregorian ligature.", + + /* properties */ + "virga " + "stropha " + "inclinatum " + "auctum " + "descendens " + "ascendens " + "oriscus " + "quilisma " + "deminutum " + "cavum " + "linea " + "pes-or-flexa " + "context-info " + "prefix-set " + ); diff --git a/lily/grid-line-interface.cc b/lily/grid-line-interface.cc index 409c4e8ff4..5bb0b097af 100644 --- a/lily/grid-line-interface.cc +++ b/lily/grid-line-interface.cc @@ -68,9 +68,16 @@ Grid_line_interface::add_grid_point (Grob *me, Grob *b) } ADD_INTERFACE (Grid_line_interface, - "A line that spanned between grid-points. ", - "elements thickness"); + "A line that is spanned between grid-points.", + + /* properties */ + "elements " + "thickness " + ); ADD_INTERFACE (Grid_point_interface, - "A spanning point for grid lines. ", - ""); + "A spanning point for grid lines.", + + /* properties */ + "" + ); diff --git a/lily/grob.cc b/lily/grob.cc index 7f78b5ff60..f5c9ebe4dd 100644 --- a/lily/grob.cc +++ b/lily/grob.cc @@ -576,39 +576,42 @@ Grob::programming_error (string s) const ADD_INTERFACE (Grob, - "A grob represents a piece of music notation\n" + "A grob represents a piece of music notation.\n" "\n" - "All grobs have an X and Y-position on the page. These X and Y positions\n" - "are stored in a relative format, so they can easily be combined by\n" - "stacking them, hanging one grob to the side of another, and coupling\n" - "them into a grouping objects.\n" + "All grobs have an X and Y@tie{}position on the page. These " + "X and Y@tie{}positions are stored in a relative format, thus " + "they can easily be combined by stacking them, hanging one " + "grob to the side of another, or coupling them into grouping " + "objects.\n" "\n" - "Each grob has a reference point (a.k.a. parent): the position of a grob\n" - "is stored relative to that reference point. For example the X-reference\n" - "point of a staccato dot usually is the note head that it applies\n" - "to. When the note head is moved, the staccato dot moves along\n" + "Each grob has a reference point (a.k.a.@: parent): The " + "position of a grob is stored relative to that reference " + "point. For example, the X@tie{}reference point of a staccato " + "dot usually is the note head that it applies to. When the " + "note head is moved, the staccato dot moves along " "automatically.\n" "\n" - "A grob is often associated with a symbol, but some grobs do not print\n" - "any symbols. They take care of grouping objects. For example, there is a\n" - "separate grob that stacks staves vertically. The @ref{NoteCollision}\n" - "is also an abstract grob: it only moves around chords, but doesn't print\n" + "A grob is often associated with a symbol, but some grobs do " + "not print any symbols. They take care of grouping objects. " + "For example, there is a separate grob that stacks staves " + "vertically. The @ref{NoteCollision} object is also an " + "abstract grob: It only moves around chords, but doesn't print " "anything.\n" "\n" - "Grobs have a properties: Scheme variables, that can be read and set. " - "They have two types. Immutable variables " - "define the default style and behavior. They are shared between many objects. " - "They can be changed using @code{\\override} and @code{\\revert}. " - "\n\n" - "Mutable properties are variables that are specific to one grob. Typically, " - "lists of other objects, or results from computations are stored in" - "mutable properties: every call to set-grob-property (or its C++ equivalent) " - "sets a mutable property. " - "\n\n" - "The properties @code{after-line-breaking} and @code{before-line-breaking} " - "are dummies that are not user-serviceable. " - - , + "Grobs have properties (Scheme variables) that can be read and " + "set. Two types of them exist: immutable and mutable. " + "Immutable variables define the default style and behavior. " + "They are shared between many objects. They can be changed " + "using @code{\\override} and @code{\\revert}. Mutable " + "properties are variables that are specific to one grob. " + "Typically, lists of other objects, or results from " + "computations are stored in mutable properties. In " + "particular, every call to @code{set-grob-property} (or its " + "C++ equivalent) sets a mutable property.\n" + "\n" + "The properties @code{after-line-breaking} and " + "@code{before-line-breaking} are dummies that are not " + "user-serviceable.", /* properties */ "X-extent " diff --git a/lily/hairpin.cc b/lily/hairpin.cc index 87f32017a4..af5607503d 100644 --- a/lily/hairpin.cc +++ b/lily/hairpin.cc @@ -256,7 +256,7 @@ Hairpin::print (SCM smob) } ADD_INTERFACE (Hairpin, - "A hairpin crescendo/decrescendo.", + "A hairpin crescendo or decrescendo.", /* props */ "adjacent-hairpins " diff --git a/lily/hara-kiri-group-spanner.cc b/lily/hara-kiri-group-spanner.cc index bf07c8ede1..89f3bf1b6a 100644 --- a/lily/hara-kiri-group-spanner.cc +++ b/lily/hara-kiri-group-spanner.cc @@ -154,10 +154,9 @@ Hara_kiri_group_spanner::add_interesting_item (Grob *me, Grob *n) } ADD_INTERFACE (Hara_kiri_group_spanner, - "A group spanner that keeps track of interesting items. If it " - "doesn't contain any after linebreaking, then it " - "will remove itself and all its children.", - + "A group spanner that keeps track of interesting items. If it " + "doesn't contain any after line breaking, it removes itself " + "and all its children.", /* properties */ "items-worth-living " diff --git a/lily/item.cc b/lily/item.cc index fdf9b00ce9..82147a4655 100644 --- a/lily/item.cc +++ b/lily/item.cc @@ -249,28 +249,31 @@ Item::less (Grob * const &g1, Grob * const &g2) } ADD_INTERFACE (Item, - - "Grobs can be distinguished in their role in the horizontal spacing.\n" - "Many grobs define constraints on the spacing by their sizes. For\n" - "example, note heads, clefs, stems, and all other symbols with a fixed\n" - "shape. These grobs form a subtype called @code{Item}.\n" - "\n" + "Grobs can be distinguished in their role in the horizontal " + "spacing. Many grobs define constraints on the spacing by " + "their sizes, for example, note heads, clefs, stems, and all " + "other symbols with a fixed shape. These grobs form a " + "subtype called @code{Item}.\n" "\n" - "Some items need special treatment for line breaking. For example, a\n" - "clef is normally only printed at the start of a line (i.e. after a\n" - "line break). To model this, `breakable' items (clef, key signature,\n" - "bar lines, etc.) are copied twice. Then we have three versions of each\n" - "breakable item: one version if there is no line break, one version\n" - "that is printed before the line break (at the end of a system), one\n" - "version that is printed after the line break.\n" + "Some items need special treatment for line breaking. For " + "example, a clef is normally only printed at the start of a " + "line (i.e., after a line break). To model this, " + "@q{breakable} items (clef, key signature, bar lines, etc.) " + "are copied twice. Then we have three versions of each " + "breakable item: one version if there is no line break, one " + "version that is printed before the line break (at the end of " + "a system), and one version that is printed after the line " + "break.\n" "\n" - "Whether these versions are visible and take up space, is determined by\n" - "the outcome of the @code{break-visibility}. This grob property is a\n" - "function taking a direction (-1, 0 or 1) as argument. It returns a\n" - "cons of booleans, signifying whether this grob should be transparent\n" - "and have no extent.\n" + "Whether these versions are visible and take up space is " + "determined by the outcome of the @code{break-visibility} " + "grob property, which is a function taking a direction (-1, 0 " + "or@tie{}1) as an argument. It returns a cons of booleans, " + "signifying whether this grob should be transparent and have " + "no extent.\n" "\n" - "The following variables for break-visibility are predefined:\n" + "The following variables for @code{break-visibility} are " + "predefined:\n" "@example\n" " grob will show: before no after\n" " break break break\n" @@ -281,10 +284,11 @@ ADD_INTERFACE (Item, " begin-of-line-invisible yes yes no\n" " end-of-line-invisible no yes yes\n" " center-invisible yes no yes\n" - "@end example\n", + "@end example", /* properties */ "break-visibility " "extra-spacing-width " "infinite-spacing-height " - "non-musical") + "non-musical " + ); diff --git a/lily/key-signature-interface.cc b/lily/key-signature-interface.cc index ddf2fbbb64..2342c944e0 100644 --- a/lily/key-signature-interface.cc +++ b/lily/key-signature-interface.cc @@ -122,6 +122,7 @@ Key_signature_interface::print (SCM smob) ADD_INTERFACE (Key_signature_interface, "A group of accidentals, to be printed as signature sign.", + /* properties */ "alteration-alist " "c0-position " "glyph-name-alist " diff --git a/lily/ledger-line-spanner.cc b/lily/ledger-line-spanner.cc index 052e69ba19..c8fb7d4ca6 100644 --- a/lily/ledger-line-spanner.cc +++ b/lily/ledger-line-spanner.cc @@ -351,10 +351,9 @@ Ledger_line_spanner::print (SCM smob) } ADD_INTERFACE (Ledger_line_spanner, - - "This spanner draws the ledger lines of a staff.\n" - "This is a separate grob because it has to process\n" - "all potential collisions between all note heads.", + "This spanner draws the ledger lines of a staff. This is a " + "separate grob because it has to process all potential " + "collisions between all note heads.", /* properties */ "gap " @@ -370,8 +369,9 @@ struct Ledgered_interface }; ADD_INTERFACE (Ledgered_interface, + "Objects that need ledger lines, typically note heads. See " + "also @ref{ledger-line-spanner-interface}.", - "Objects that need ledger lines, typically " - "note heads. See also @ref{ledger-line-spanner-interface}.", - - "no-ledgers"); + /* properties */ + "no-ledgers " + ); diff --git a/lily/line-interface.cc b/lily/line-interface.cc index 2b4639c5d2..6d2d44045a 100644 --- a/lily/line-interface.cc +++ b/lily/line-interface.cc @@ -248,15 +248,15 @@ Line_interface::line (Grob *me, Offset from, Offset to) } ADD_INTERFACE (Line_interface, - "Generic line objects. Any object using lines supports this. " + "Generic line objects. Any object using lines supports this. " "The property @code{style} can be @code{line}, " - "@code{dashed-line}, @code{trill}, \n" - "@code{dotted-line} or @code{zigzag}.\n" + "@code{dashed-line}, @code{trill}, @code{dotted-line} or " + "@code{zigzag}.\n" "\n" - "For dashed-line, the length of the dashes is tuned with " - "@code{dash-fraction}. If the latter is set to 0, a dotted line is " - "produced. If @code{dash-period} is negative, the line is made " - "transparent.", + "For @code{dashed-line}, the length of the dashes is tuned " + "with @code{dash-fraction}. If the latter is set to@tie{}0, a " + "dotted line is produced. If @code{dash-period} is negative, " + "the line is made transparent.", /* properties */ "dash-period " diff --git a/lily/line-spanner.cc b/lily/line-spanner.cc index d0063c9532..290c7cb74c 100644 --- a/lily/line-spanner.cc +++ b/lily/line-spanner.cc @@ -348,12 +348,14 @@ Line_spanner::print (SCM smob) } ADD_INTERFACE (Line_spanner, - "Generic line drawn between two objects, e.g. for use with glissandi.\n" + "Generic line drawn between two objects, e.g., for use with " + "glissandi.\n" + "\n" "The property @code{style} can be @code{line}, " - "@code{dashed-line}, @code{trill}, \n" - "@code{dotted-line} or @code{zigzag}.\n" - "\n", + "@code{dashed-line}, @code{trill}, @code{dotted-line} or " + "@code{zigzag}.", + /* properties */ "bound-details " "extra-dy " "gap " diff --git a/lily/lyric-extender.cc b/lily/lyric-extender.cc index de7452eb51..877c84bfe7 100644 --- a/lily/lyric-extender.cc +++ b/lily/lyric-extender.cc @@ -90,8 +90,10 @@ Lyric_extender::print (SCM smob) ADD_INTERFACE (Lyric_extender, "The extender is a simple line at the baseline of the lyric " - "that helps show the length of a melissima (tied/slurred note).", + "that helps show the length of a melisma (a tied or slurred " + "note).", + /* properties */ "heads " "left-padding " "next " diff --git a/lily/lyric-hyphen.cc b/lily/lyric-hyphen.cc index d50a997276..416ad20d86 100644 --- a/lily/lyric-hyphen.cc +++ b/lily/lyric-hyphen.cc @@ -130,11 +130,10 @@ Lyric_hyphen::set_spacing_rods (SCM smob) } ADD_INTERFACE (Lyric_hyphen, + "A centered hyphen is simply a line between lyrics used to " + "divide syllables.", - "A centered hyphen is a simple line between " - "lyrics used to divide syllables", - - /* props */ + /* properties */ "dash-period " "height " "length " diff --git a/lily/measure-grouping-spanner.cc b/lily/measure-grouping-spanner.cc index f2cd989474..2048abc5d2 100644 --- a/lily/measure-grouping-spanner.cc +++ b/lily/measure-grouping-spanner.cc @@ -48,7 +48,12 @@ Measure_grouping::print (SCM grob) } ADD_INTERFACE (Measure_grouping, - "This object indicates groups of beats. " - "Valid choices for @code{style} are @code{bracket} and @code{triangle}.", - "thickness style height"); + "This object indicates groups of beats. Valid choices for " + "@code{style} are @code{bracket} and @code{triangle}.", + + /* properties */ + "thickness " + "style " + "height " + ); diff --git a/lily/melody-spanner.cc b/lily/melody-spanner.cc index a3e185bbdb..4d1cc67ae9 100644 --- a/lily/melody-spanner.cc +++ b/lily/melody-spanner.cc @@ -95,7 +95,9 @@ Melody_spanner::add_stem (Grob *me, Grob *stem) ADD_INTERFACE (Melody_spanner, "Context dependent typesetting decisions.", + /* properties */ "stems " - "neutral-direction "); + "neutral-direction " + ); diff --git a/lily/mensural-ligature.cc b/lily/mensural-ligature.cc index 12b5218429..f4d2a2fd2b 100644 --- a/lily/mensural-ligature.cc +++ b/lily/mensural-ligature.cc @@ -220,13 +220,14 @@ Mensural_ligature::print (SCM) } ADD_INTERFACE (Mensural_ligature, - "A mensural ligature", + "A mensural ligature.", + /* properties */ "delta-position " "flexa-width " "head-width " "join-right-amount " "primitive " - "thickness" + "thickness " ); diff --git a/lily/multi-measure-rest.cc b/lily/multi-measure-rest.cc index 68c56de9c6..d16a11e3db 100644 --- a/lily/multi-measure-rest.cc +++ b/lily/multi-measure-rest.cc @@ -354,5 +354,6 @@ ADD_INTERFACE (Multi_measure_rest, "thick-thickness " "use-breve-rest " "bound-padding " - "minimum-length"); + "minimum-length " + ); diff --git a/lily/note-collision.cc b/lily/note-collision.cc index ab15741288..1b654a713b 100644 --- a/lily/note-collision.cc +++ b/lily/note-collision.cc @@ -579,10 +579,11 @@ Note_collision_interface::add_column (Grob *me, Grob *ncol) } ADD_INTERFACE (Note_collision_interface, - "An object that handles collisions between notes with different stem " - "directions and horizontal shifts. Most of the interesting properties " - "are to be set in @ref{note-column-interface}: these are " - "@code{force-hshift} and @code{horizontal-shift}.", + "An object that handles collisions between notes with " + "different stem directions and horizontal shifts. Most of " + "the interesting properties are to be set in " + "@ref{note-column-interface}: these are @code{force-hshift} " + "and @code{horizontal-shift}.", /* properties */ "merge-differently-dotted " diff --git a/lily/note-column.cc b/lily/note-column.cc index e1a8e695fd..67d4f78e8a 100644 --- a/lily/note-column.cc +++ b/lily/note-column.cc @@ -210,7 +210,7 @@ Note_column::cross_staff_extent (Grob *me, Grob *refp) } ADD_INTERFACE (Note_column, - "Stem and noteheads combined", + "Stem and noteheads combined.", /* properties */ "arpeggio " diff --git a/lily/note-head.cc b/lily/note-head.cc index c711f8729e..1c03808819 100644 --- a/lily/note-head.cc +++ b/lily/note-head.cc @@ -143,7 +143,7 @@ Note_head::calc_stem_attachment (SCM smob) ADD_INTERFACE (Note_head, - "Note head", + "Note head.", /* properties */ "note-names " diff --git a/lily/note-spacing.cc b/lily/note-spacing.cc index ffb9d7c40e..90db07a7e8 100644 --- a/lily/note-spacing.cc +++ b/lily/note-spacing.cc @@ -313,13 +313,12 @@ Note_spacing::stem_dir_correction (Grob *me, Item *rcolumn, ADD_INTERFACE (Note_spacing, "This object calculates spacing wishes for individual voices.", - + /* properties */ "knee-spacing-correction " "left-items " "right-items " "same-direction-correction " "stem-spacing-correction " "space-to-barline " - ); diff --git a/lily/ottava-bracket.cc b/lily/ottava-bracket.cc index 2f23261eb9..a2ed6b5422 100644 --- a/lily/ottava-bracket.cc +++ b/lily/ottava-bracket.cc @@ -176,13 +176,12 @@ Ottava_bracket::print (SCM smob) } ADD_INTERFACE (Ottava_bracket, - "An ottava bracket", + "An ottava bracket.", - /* - properties - */ + /* properties */ "edge-height " "bracket-flare " "shorten-pair " - "minimum-length"); + "minimum-length " + ); diff --git a/lily/paper-column.cc b/lily/paper-column.cc index ba5b36b13e..e347def407 100644 --- a/lily/paper-column.cc +++ b/lily/paper-column.cc @@ -314,19 +314,18 @@ Paper_column::before_line_breaking (SCM grob) ADD_INTERFACE (Paper_column, - "@code{Paper_column} objects form the top-most X-parents for items." - " The are two types of columns: musical columns, where are attached to, and " - " non-musical columns, where bar-lines, clefs etc. are attached to. " - " The spacing engine determines the X-positions of these objects." - - "\n\n" - "They are\n" - " numbered, the first (leftmost) is column 0. Numbering happens before\n" - " line-breaking, and columns are not renumbered after line breaking.\n" - " Since many columns go unused, you should only use the rank field to\n" - " get ordering information. Two adjacent columns may have\n" - " non-adjacent numbers.\n", - + "@code{Paper_column} objects form the top-most X@tie{}parents " + "for items. There are two types of columns: musical columns, " + "where are attached to, and non-musical columns, where " + "bar-lines, clefs, etc., are attached to. The spacing engine " + "determines the X@tie{}positions of these objects.\n" + "\n" + "They are numbered, the first (leftmost) is column@tie{}0. " + "Numbering happens before line breaking, and columns are not " + "renumbered after line breaking. Since many columns go " + "unused, you should only use the rank field to get ordering " + "information. Two adjacent columns may have non-adjacent " + "numbers.", /* properties */ "between-cols " @@ -345,5 +344,6 @@ ADD_INTERFACE (Paper_column, "shortest-starter-duration " "spacing " "used " - "when "); + "when " + ); diff --git a/lily/percent-repeat-item.cc b/lily/percent-repeat-item.cc index 451647fb5c..b0c86c45b4 100644 --- a/lily/percent-repeat-item.cc +++ b/lily/percent-repeat-item.cc @@ -71,8 +71,10 @@ Percent_repeat_item_interface::beat_slash (SCM grob) } ADD_INTERFACE (Percent_repeat_item_interface, - "Repeats that look like percent signs", + "Repeats that look like percent signs.", + /* properties */ "slope " - "thickness "); + "thickness " + ); diff --git a/lily/piano-pedal-bracket.cc b/lily/piano-pedal-bracket.cc index efda1be5cd..99267adbea 100644 --- a/lily/piano-pedal-bracket.cc +++ b/lily/piano-pedal-bracket.cc @@ -90,14 +90,13 @@ Piano_pedal_bracket::print (SCM smob) } ADD_INTERFACE (Piano_pedal_bracket, + "The bracket of the piano pedal. It can be tuned through " + "the regular bracket properties.", - "The bracket of the piano pedal. " - "It can be tuned through the regular " - "bracket properties.", - - /* props */ + /* properties */ "bound-padding " "edge-height " "shorten-pair " "bracket-flare " - "pedal-text "); + "pedal-text " + ); diff --git a/lily/rest-collision.cc b/lily/rest-collision.cc index dd92f083e3..ccd18f17e7 100644 --- a/lily/rest-collision.cc +++ b/lily/rest-collision.cc @@ -278,5 +278,6 @@ ADD_INTERFACE (Rest_collision, /* properties */ "minimum-distance " "positioning-done " - "elements"); + "elements " + ); diff --git a/lily/rest.cc b/lily/rest.cc index 92e0e6e029..1f756c4c91 100644 --- a/lily/rest.cc +++ b/lily/rest.cc @@ -188,12 +188,11 @@ Rest::pure_height (SCM smob, SCM start, SCM end) } ADD_INTERFACE (Rest, - "A rest symbol." - "The property @code{style} can be @code{default}, " - "@code{mensural}, @code{neomensural} or @code{classical}.", + "A rest symbol. The property @code{style} can be " + "@code{default}, @code{mensural}, @code{neomensural} or " + "@code{classical}.", /* properties */ - "direction " "minimum-distance " "style " diff --git a/lily/rhythmic-head.cc b/lily/rhythmic-head.cc index 93349e06fe..436da6b612 100644 --- a/lily/rhythmic-head.cc +++ b/lily/rhythmic-head.cc @@ -49,11 +49,10 @@ Rhythmic_head::duration_log (Grob *me) } ADD_INTERFACE (Rhythmic_head, - - "Note head or rest", + "Note head or rest.", + /* properties */ "dot " "duration-log " "stem " ); - diff --git a/lily/script-column.cc b/lily/script-column.cc index 3e4092f7c6..4bea9e31fc 100644 --- a/lily/script-column.cc +++ b/lily/script-column.cc @@ -154,7 +154,9 @@ Script_column::order_grobs (vector grobs) } ADD_INTERFACE (Script_column, - "An interface that sorts scripts " - "according to their @code{script-priority}", + "An interface that sorts scripts according to their " + "@code{script-priority}.", - ""); + /* properties */ + "" + ); diff --git a/lily/script-interface.cc b/lily/script-interface.cc index b965959d5d..f6957f9eea 100644 --- a/lily/script-interface.cc +++ b/lily/script-interface.cc @@ -111,7 +111,7 @@ struct Text_script }; ADD_INTERFACE (Text_script, - "An object that is put above or below a note", + "An object that is put above or below a note.", /* properties */ "add-stem-support " @@ -124,7 +124,9 @@ ADD_INTERFACE (Text_script, Hmm. Where should we put add-stem-support ? */ ADD_INTERFACE (Script_interface, - "An object that is put above or below a note", + "An object that is put above or below a note.", + + /* properties */ "add-stem-support " "avoid-slur " "positioning-done " diff --git a/lily/self-aligment-interface.cc b/lily/self-aligment-interface.cc index b990ff01c0..c6de581aca 100644 --- a/lily/self-aligment-interface.cc +++ b/lily/self-aligment-interface.cc @@ -138,20 +138,21 @@ Self_alignment_interface::set_align_self (Grob *me, Axis a) } ADD_INTERFACE (Self_alignment_interface, - "Position this object on itself and/or on its parent. To this end, the following functions " - " are provided: \n" - "@table @code \n" + "Position this object on itself and/or on its parent. To this " + "end, the following functions are provided:\n" + "\n" + "@table @code\n" "@item Self_alignment_interface::[xy]_aligned_on_self\n" - " Align self on reference point, using @code{self-alignment-X} and " - "@code{self-alignment-Y}." + " Align self on reference point, using " + " @code{self-alignment-X} and @code{self-alignment-Y}." "@item Self_alignment_interface::aligned_on_[xy]_parent\n" "@item Self_alignment_interface::centered_on_[xy]_parent\n" - " Shift the object so its own reference point is centered on the " - " extent of the parent \n" + " Shift the object so its own reference point is centered on " + " the extent of the parent\n" "@end table\n", - /* properties */ "self-alignment-X " - "self-alignment-Y "); + "self-alignment-Y " + ); diff --git a/lily/semi-tie-column.cc b/lily/semi-tie-column.cc index 4b1bf76a39..f7a7be4968 100644 --- a/lily/semi-tie-column.cc +++ b/lily/semi-tie-column.cc @@ -21,7 +21,7 @@ ADD_INTERFACE (Semi_tie_column, - "The interface for a column of l.v. ties.", + "The interface for a column of l.v. (laissez vibrer) ties.", /* properties */ "positioning-done " diff --git a/lily/semi-tie.cc b/lily/semi-tie.cc index a12156e603..4f3c6b39d8 100644 --- a/lily/semi-tie.cc +++ b/lily/semi-tie.cc @@ -16,8 +16,7 @@ #include "staff-symbol-referencer.hh" ADD_INTERFACE (Semi_tie, - - "A tie which is only on one side connected to note heads. ", + "A tie which is only on one side connected to a note head.", /* properties */ "control-points " diff --git a/lily/separation-item.cc b/lily/separation-item.cc index f8d1cb739f..5c9eb9ef10 100644 --- a/lily/separation-item.cc +++ b/lily/separation-item.cc @@ -156,9 +156,9 @@ Separation_item::print (SCM smob) } ADD_INTERFACE (Separation_item, - "Item that computes widths to generate spacing rods. " - , + "Item that computes widths to generate spacing rods.", + /* properties */ "X-extent " "conditional-elements " "elements " diff --git a/lily/side-position-interface.cc b/lily/side-position-interface.cc index a289aea5b3..6422db2122 100644 --- a/lily/side-position-interface.cc +++ b/lily/side-position-interface.cc @@ -303,11 +303,14 @@ Side_position_interface::get_axis (Grob *me) } ADD_INTERFACE (Side_position_interface, - "Position a victim object (this one) next to other objects (the " - "support). The property @code{direction} signifies where to put the " - "victim object relative to the support (left or right, up or down?)\n\n " - "The routine also takes the size the staff into account if " - "@code{staff-padding} is set. If undefined, the staff symbol is ignored.", + "Position a victim object (this one) next to other objects " + "(the support). The property @code{direction} signifies where " + "to put the victim object relative to the support (left or " + "right, up or down?)\n" + "\n" + "The routine also takes the size of the staff into account if " + "@code{staff-padding} is set. If undefined, the staff symbol " + "is ignored.", /* properties */ "direction " diff --git a/lily/slur.cc b/lily/slur.cc index 2e573ebf7c..3d47e876fc 100644 --- a/lily/slur.cc +++ b/lily/slur.cc @@ -387,8 +387,7 @@ Slur::calc_cross_staff (SCM smob) } ADD_INTERFACE (Slur, - - "A slur", + "A slur.", /* properties */ "annotation " diff --git a/lily/spaceable-grob.cc b/lily/spaceable-grob.cc index 87d30397e3..725c4759c6 100644 --- a/lily/spaceable-grob.cc +++ b/lily/spaceable-grob.cc @@ -89,8 +89,7 @@ Spaceable_grob::get_spring (Grob *this_col, Grob *next_col) ADD_INTERFACE (Spaceable_grob, - "A layout object that takes part in the spacing problem. ", - + "A layout object that takes part in the spacing problem.", /* properties */ "allow-loose-spacing " @@ -101,6 +100,5 @@ ADD_INTERFACE (Spaceable_grob, "minimum-distances " "right-neighbors " "spacing-wishes " - ); diff --git a/lily/spacing-interface.cc b/lily/spacing-interface.cc index 65ac96834f..072bdbb39d 100644 --- a/lily/spacing-interface.cc +++ b/lily/spacing-interface.cc @@ -247,8 +247,10 @@ Spacing_interface::extremal_break_aligned_grob (Grob *me, ADD_INTERFACE (Spacing_interface, - "This object calculates the desired and minimum distances between two columns.", + "This object calculates the desired and minimum distances " + "between two columns.", + /* properties */ "left-items " "right-items " ); diff --git a/lily/spacing-spanner.cc b/lily/spacing-spanner.cc index 8ebf100a53..c972dac5cc 100644 --- a/lily/spacing-spanner.cc +++ b/lily/spacing-spanner.cc @@ -517,18 +517,20 @@ Spacing_spanner::breakable_column_spacing (Grob *me, Item *l, Item *r, } ADD_INTERFACE (Spacing_spanner, - "The space taken by a note is dependent on its duration. Doubling a\n" - "duration adds spacing-increment to the space. The most common shortest\n" - "note gets @code{shortest-duration-space}. Notes that are even shorter are\n" - "spaced proportonial to their duration.\n" + "The space taken by a note is dependent on its duration. " + "Doubling a duration adds @code{spacing-increment} to the " + "space. The most common shortest note gets " + "@code{shortest-duration-space}. Notes that are even shorter " + "are spaced proportonial to their duration.\n" "\n" - "Typically, the increment is the width of a black note head. In a\n" - "piece with lots of 8th notes, and some 16th notes, the eighth note\n" - "gets 2 note heads width (i.e. the space following a note is 1 note\n" - "head width) A 16th note is followed by 0.5 note head width. The\n" - "quarter note is followed by 3 NHW, the half by 4 NHW, etc.\n", - - + "Typically, the increment is the width of a black note head. " + "In a piece with lots of 8th notes, and some 16th notes, the " + "eighth note gets a 2@tie{}note heads width (i.e., the space " + "following a note is a 1@tie{}note head width). A 16th note " + "is followed by 0.5 note head width. The quarter note is " + "followed by 3@tie{}NHW, the half by 4@tie{}NHW, etc.", + + /* properties */ "average-spacing-wishes " "base-shortest-duration " "common-shortest-duration " @@ -538,6 +540,5 @@ ADD_INTERFACE (Spacing_spanner, "strict-grace-spacing " "strict-note-spacing " "uniform-stretching " - ); diff --git a/lily/span-bar.cc b/lily/span-bar.cc index 67d464297d..75999a7846 100644 --- a/lily/span-bar.cc +++ b/lily/span-bar.cc @@ -212,10 +212,12 @@ Span_bar::calc_bar_size (SCM smob) } ADD_INTERFACE (Span_bar, - "A bar line that spanned between other barlines. This interface is " - " used for bar lines that connect different staves.", + "A bar line that is spanned between other barlines. This " + "interface is used for bar lines that connect different " + "staves.", /* properties */ "glyph-name " - "elements"); + "elements " + ); diff --git a/lily/spanner.cc b/lily/spanner.cc index b5b8a933a2..1cfcf093eb 100644 --- a/lily/spanner.cc +++ b/lily/spanner.cc @@ -424,12 +424,14 @@ Spanner::bounds_width (SCM grob) } ADD_INTERFACE (Spanner, - "Some objects are horizontally spanned between objects. For\n" - "example, slur, beam, tie, etc. These grobs form a subtype called\n" - "@code{Spanner}. All spanners have two span-points (these must be\n" - "@code{Item} objects), one on the left and one on the right. The left bound is\n" - "also the X-reference point of the spanner.\n", - + "Some objects are horizontally spanned between objects. For " + "example, slurs, beams, ties, etc. These grobs form a subtype " + "called @code{Spanner}. All spanners have two span points " + "(these must be @code{Item} objects), one on the left and one " + "on the right. The left bound is also the X@tie{}reference " + "point of the spanner.", + + /* properties */ "minimum-length " "to-barline " ); diff --git a/lily/staff-spacing.cc b/lily/staff-spacing.cc index 06bceb8580..5bfea17b3f 100644 --- a/lily/staff-spacing.cc +++ b/lily/staff-spacing.cc @@ -201,9 +201,9 @@ Staff_spacing::get_spacing (Grob *me, Grob *right_col) } ADD_INTERFACE (Staff_spacing, - "This object calculates spacing details from a " - " breakable symbol (left) to another object. For example, it takes care " - " of optical spacing from a bar lines to a note.", + "This object calculates spacing details from a breakable " + "symbol (left) to another object. For example, it takes care " + "of optical spacing from a bar line to a note.", /* properties */ "stem-spacing-correction " diff --git a/lily/staff-symbol-referencer.cc b/lily/staff-symbol-referencer.cc index 53637c86e5..2077a50082 100644 --- a/lily/staff-symbol-referencer.cc +++ b/lily/staff-symbol-referencer.cc @@ -183,12 +183,12 @@ position_less (Grob *const &a, Grob *const &b) } ADD_INTERFACE (Staff_symbol_referencer, - "An object whose Y position is meant relative to a staff " - "symbol. " - "These usually have @code{Staff_symbol_referencer::callback} " - "in their @code{Y-offset-callbacks}. ", + "An object whose Y@tie{}position is meant relative to a staff " + "symbol. These usually " + "have @code{Staff_symbol_referencer::callback} in their " + "@code{Y-offset-callbacks}.", /* properties */ - "staff-position"); - - + "staff-position " + ); + \ No newline at end of file diff --git a/lily/staff-symbol.cc b/lily/staff-symbol.cc index a6ab40d909..3604be85a3 100644 --- a/lily/staff-symbol.cc +++ b/lily/staff-symbol.cc @@ -171,13 +171,12 @@ Staff_symbol::height (SCM smob) ADD_INTERFACE (Staff_symbol, - "This spanner draws the lines of a staff. " - "A staff symbol definines a vertical unit, the staff space. " - "Quantities that go by a half staff space are called positions " - "The center (i.e. middle line " - "or space) is position 0. The length of the symbol may be set by hand " - "through the @code{width} property. ", - + "This spanner draws the lines of a staff. A staff symbol " + "defines a vertical unit, the @empf{staff space}. Quantities " + "that go by a half staff space are called @emph{positions}. " + "The center (i.e., middle line or space) is position@tie{}0. " + "The length of the symbol may be set by hand through the " + "@code{width} property.", /* properties */ "ledger-line-thickness " diff --git a/lily/stem-tremolo.cc b/lily/stem-tremolo.cc index 8960fe64ad..a41675137e 100644 --- a/lily/stem-tremolo.cc +++ b/lily/stem-tremolo.cc @@ -247,9 +247,8 @@ Stem_tremolo::print (SCM grob) } ADD_INTERFACE (Stem_tremolo, - "A beam slashing a stem to indicate a tremolo. " - "The property @code{style} can be @code{default} or " - "@code{rectangle}.", + "A beam slashing a stem to indicate a tremolo. The property " + "@code{style} can be @code{default} or @code{rectangle}.", /* properties */ "beam-thickness " diff --git a/lily/stem.cc b/lily/stem.cc index 31311f101d..34525194e7 100644 --- a/lily/stem.cc +++ b/lily/stem.cc @@ -996,27 +996,30 @@ Stem::calc_cross_staff (SCM smob) /* FIXME: Too many properties */ ADD_INTERFACE (Stem, - "The stem represent the graphical stem. " - "In addition, it internally connects note heads, beams and" - "tremolos. " - "Rests and whole notes have invisible stems." - - "\n\nThe following properties may be set in the details list." + "The stem represents the graphical stem. In addition, it " + "internally connects note heads, beams, and tremolos. Rests " + "and whole notes have invisible stems.\n" + "\n" + "The following properties may be set in the @code{details} " + "list.\n" + "\n" "@table @code\n" - "@item beamed-lengths \n" - "list of stem lengths given beam multiplicity. \n" - "@item beamed-minimum-free-lengths \n" - "list of normal minimum free stem lengths (chord to beams) given beam multiplicity.\n" + "@item beamed-lengths\n" + " List of stem lengths given beam multiplicity.\n" + "@item beamed-minimum-free-lengths\n" + " List of normal minimum free stem lengths (chord to beams) " + " given beam multiplicity.\n" "@item beamed-extreme-minimum-free-lengths\n" - "list of extreme minimum free stem lengths (chord to beams) given beam multiplicity.\n" + " List of extreme minimum free stem lengths (chord to beams) " + " given beam multiplicity.\n" "@item lengths\n" - "Default stem lengths. The list gives a length for each flag-count.\n" + " Default stem lengths. The list gives a length for each " + " flag count.\n" "@item stem-shorten\n" - "How much a stem in a forced direction " - "should be shortened. The list gives an amount depending on the number " - "of flags/beams." - "@end table\n" - , + " How much a stem in a forced direction should be shortened. " + " The list gives an amount depending on the number of flags " + " and beams.\n" + "@end table\n", /* properties */ "avoid-note-head " diff --git a/lily/system-start-delimiter.cc b/lily/system-start-delimiter.cc index 1fe9456930..78e7426722 100644 --- a/lily/system-start-delimiter.cc +++ b/lily/system-start-delimiter.cc @@ -173,32 +173,30 @@ System_start_delimiter::staff_brace (Grob *me, Real y) } ADD_INTERFACE (System_start_delimiter, - "The brace, bracket or bar in front of the system. The following " - "values for @code{style} are recognized:\n" - "\n" - " @table @samp\n" - " @item @code{bracket}\n" - " A thick bracket, normally used to group similar\n" - " instruments in a score. Default for StaffGroup.\n" - " SystemStartBracket use this style.\n" - "\n" - " @item @code{brace}\n" - " A \"piano style\" brace normally used for an instrument\n" - " that use two staffs. The default style for GrandStaff.\n" - " SystemStartBrace use this style.\n" - "\n" - " @item @code{bar-line}\n" - " A simple line between the staffs in a score. Default\n" - " for staffs enclosed in << >>.\n" - " SystemStartBar use this style.\n" - "\n" - " @item @code{line-bracket}\n" - " A simple square, normally used for subgrouping\n" - " instruments in a score.\n" - " SystemStartSquare use this style.\n" - " @end table\n" - "\n" - "See also @file{input/regression/system-start-nesting.ly}. ", + "The brace, bracket or bar in front of the system. The " + "following values for @code{style} are recognized:\n" + "\n" + "@table @code\n" + "@item bracket\n" + " A thick bracket, normally used to group similar " + " instruments in a score. Default for @code{StaffGroup}. " + " @code{SystemStartBracket} uses this style.\n" + "@item brace\n" + " A @q{piano style} brace normally used for an instrument " + " that uses two staves. The default style for " + " @code{GrandStaff}. @code{SystemStartBrace} uses this " + " style.\n" + "@item bar-line\n" + " A simple line between the staves in a score. Default " + " for staves enclosed in @code{<<} and @code{>>}. " + " @code{SystemStartBar} uses this style.\n" + "@item line-bracket\n" + " A simple square, normally used for subgrouping " + " instruments in a score. @code{SystemStartSquare} uses " + " this style.\n" + "@end table\n" + "\n" + "See also @file{input/regression/system-start-nesting.ly}.", /* properties */ "collapse-height " diff --git a/lily/system.cc b/lily/system.cc index e8af537be1..2968028ab8 100644 --- a/lily/system.cc +++ b/lily/system.cc @@ -512,8 +512,9 @@ get_root_system (Grob *me) } ADD_INTERFACE (System, - "This is the toplevel object: each object in a score " - "ultimately has a System object as its X and Y parent. ", + "This is the top-level object: Each object in a score " + "ultimately has a @code{System} object as its X and " + "Y@tie{}parent.", /* properties */ "all-elements " diff --git a/lily/text-interface.cc b/lily/text-interface.cc index b1ee537baa..eeb41ffd1b 100644 --- a/lily/text-interface.cc +++ b/lily/text-interface.cc @@ -137,13 +137,15 @@ Text_interface::is_markup_list (SCM x) ADD_INTERFACE (Text_interface, - "A scheme markup text, see @ruser{Text markup} and " - "@ruser{New markup command definition}. " - "\n\n" - "There are two important commands: ly:text-interface::print, which is a " - "grob callback, and ly:text-interface::interpret-markup ", - - /* props */ + "A Scheme markup text, see @ruser{Text markup} and " + "@ruser{New markup command definition}.\n" + "\n" + "There are two important commands: " + "@code{ly:text-interface::print}, which is a " + "grob callback, and " + "@code{ly:text-interface::interpret-markup}.", + + /* properties */ "baseline-skip " "text " "word-space " diff --git a/lily/tie-column.cc b/lily/tie-column.cc index eb2a00d84c..6a79918f51 100644 --- a/lily/tie-column.cc +++ b/lily/tie-column.cc @@ -111,7 +111,7 @@ Tie_column::calc_positioning_done (SCM smob) ADD_INTERFACE (Tie_column, - "Object that sets directions of multiple ties in a tied chord", + "Object that sets directions of multiple ties in a tied chord.", /* properties */ "positioning-done " diff --git a/lily/tie.cc b/lily/tie.cc index 9925aa428b..19feb2e26d 100644 --- a/lily/tie.cc +++ b/lily/tie.cc @@ -300,10 +300,8 @@ Tie::print (SCM smob) } ADD_INTERFACE (Tie, - "A horizontal curve connecting two noteheads. \n\n" - , + "A horizontal curve connecting two noteheads.", - /* properties */ "annotation " "avoid-slur " // UGH. @@ -318,7 +316,6 @@ ADD_INTERFACE (Tie, "quant-score " "staff-position " "thickness " - ); diff --git a/lily/time-signature.cc b/lily/time-signature.cc index c4afd8caa0..79adcbfb17 100644 --- a/lily/time-signature.cc +++ b/lily/time-signature.cc @@ -121,28 +121,29 @@ Time_signature::numbered_time_signature (Grob *me, int num, int den) } ADD_INTERFACE (Time_signature, - "A time signature, in different styles.\n" - " The following values for 'style are are recognized:\n" + "A time signature, in different styles. The following values " + "for @code{style} are are recognized:\n" "\n" - " @table @samp\n" - " @item @code{C}\n" - " 4/4 and 2/2 are typeset as C and struck C, respectively. All\n" - " other time signatures are written with two digits.\n" + "@table @code\n" + "@item C\n" + " 4/4 and 2/2 are typeset as C and struck C, respectively. " + " All other time signatures are written with two digits.\n" + "@item neomensural\n" + " 2/2, 3/2, 2/4, 3/4, 4/4, 6/4, 9/4, 4/8, 6/8, and 9/8 are " + " typeset with neo-mensural style mensuration marks. All " + " other time signatures are written with two digits.\n" + "@item mensural\n" + " 2/2, 3/2, 2/4, 3/4, 4/4, 6/4, 9/4, 4/8, 6/8, and 9/8 are " + " typeset with mensural style mensuration marks. All other " + " time signatures are written with two digits.\n" + "@item single-digit\n" + " All time signatures are typeset with a single digit, e.g., " + " 3/2 is written as 3.\n" + "@end table\n" "\n" - " @item @code{neomensural}\n" - " 2/2, 3/2, 2/4, 3/4, 4/4, 6/4, 9/4, 4/8, 6/8 and 9/8 are\n" - " typeset with neo-mensural style mensuration marks. All other time\n" - " signatures are written with two digits.\n" - "\n" - " @item @code{mensural}\n" - " 2/2, 3/2, 2/4, 3/4, 4/4, 6/4, 9/4, 4/8, 6/8 and 9/8 are\n" - " typeset with mensural style mensuration marks. All other time\n" - " signatures are written with two digits.\n" - "\n" - " @item @code{single-digit}\n" - " All time signatures are typeset with a single\n" - " digit, e.g. 3/2 is written as 3.\n" - " @end table\n" - "\n" - "See also the test-file @file{input/test/time.ly}.\n", - "fraction style"); + "See also the test-file @file{input/test/time.ly}.", + + /* properties */ + "fraction " + "style " + ); diff --git a/lily/tuplet-bracket.cc b/lily/tuplet-bracket.cc index 09d336b4a2..b52cd5b765 100644 --- a/lily/tuplet-bracket.cc +++ b/lily/tuplet-bracket.cc @@ -767,13 +767,11 @@ Tuplet_bracket::calc_cross_staff (SCM smob) } ADD_INTERFACE (Tuplet_bracket, - "A bracket with a number in the middle, used for tuplets. " - "When the bracket spans a line break, the value of " + "A bracket with a number in the middle, used for tuplets. " + "When the bracket spans a line break, the value of " "@code{break-overshoot} determines how far it extends " - "beyond the staff. " - "At a line break, the markups in the @code{edge-text} are printed " - "at the edges. ", - + "beyond the staff. At a line break, the markups in the " + "@code{edge-text} are printed at the edges.", /* properties */ "bracket-flare " @@ -792,6 +790,7 @@ ADD_INTERFACE (Tuplet_bracket, "shorten-pair " "staff-padding " "thickness " - "tuplets "); + "tuplets " + ); diff --git a/lily/tuplet-number.cc b/lily/tuplet-number.cc index 78697ca4b1..b344200a5c 100644 --- a/lily/tuplet-number.cc +++ b/lily/tuplet-number.cc @@ -66,10 +66,10 @@ Tuplet_number::calc_cross_staff (SCM smob) } ADD_INTERFACE (Tuplet_number, - "The number for a bracket. " - , + "The number for a bracket.", /* properties */ "avoid-slur " // UGH. - "bracket "); + "bracket " + ); diff --git a/lily/vaticana-ligature.cc b/lily/vaticana-ligature.cc index 58978a0839..f48bb7cbb3 100644 --- a/lily/vaticana-ligature.cc +++ b/lily/vaticana-ligature.cc @@ -293,7 +293,7 @@ Vaticana_ligature::print (SCM) } ADD_INTERFACE (Vaticana_ligature, - "A vaticana style gregorian ligature", + "A vaticana style Gregorian ligature.", /* properties */ "glyph-name " diff --git a/lily/volta-bracket.cc b/lily/volta-bracket.cc index e1d3fa8a4a..cfae83259c 100644 --- a/lily/volta-bracket.cc +++ b/lily/volta-bracket.cc @@ -160,10 +160,11 @@ Volta_bracket_interface::add_bar (Grob *me, Item *b) } ADD_INTERFACE (Volta_bracket_interface, - "Volta bracket with number", + "Volta bracket with number.", /* properties */ "bars " "thickness " - "height"); + "height " + );