]> git.donarmstrong.com Git - lilypond.git/commitdiff
Document the 'style property in custos, dots, and system-start-delimiter interface.
authorErlend Aasland <erlend.aasland@mac.com>
Tue, 11 Mar 2008 09:38:10 +0000 (10:38 +0100)
committerErlend Aasland <erlend.aasland@mac.com>
Tue, 11 Mar 2008 09:38:10 +0000 (10:38 +0100)
lily/custos.cc
lily/dots.cc
lily/system-start-delimiter.cc

index 3ed96f6a992ec4ec59f533cca3b5c1cacf1cb8bf..92ea11c43510211794b47c3d779677a3e5f6e138 100644 (file)
@@ -82,7 +82,11 @@ Custos::print (SCM smob)
 }
 
 ADD_INTERFACE (Custos,
-              "A custos object.",
+              "A custos object.  @code{style} can have four valid values: "
+              "mensural, vaticana, medicaea and hufnagel.  Mensural is the "
+              "default style. ",
+
+              /* properties */
               "style "
               "neutral-position "
-              "neutral-direction ");
+               "neutral-direction ");
index 97ac61128e8e0ffe20901b1ec5ccec4313c6dd25..cb46d269a04f3c8020cd1fec8bc32f43a09cc96d 100644 (file)
@@ -61,7 +61,9 @@ 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.",
+              "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 "
index 64450ec25e236556d174391f00d46d45735a0f14..1fe945693066d322f697381866644d92624587b8 100644 (file)
@@ -173,8 +173,32 @@ 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 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}. ",
 
               /* properties */
               "collapse-height "