From: Erlend Aasland <erlend.aasland@mac.com>
Date: Tue, 11 Mar 2008 09:38:10 +0000 (+0100)
Subject: Document the 'style property in custos, dots, and system-start-delimiter interface.
X-Git-Tag: release/2.11.43-1~40^2~12^2
X-Git-Url: https://git.donarmstrong.com/?a=commitdiff_plain;h=2baf3f47aee4113547a5708e32d721f7e5d07846;p=lilypond.git

Document the 'style property in custos, dots, and system-start-delimiter interface.
---

diff --git a/lily/custos.cc b/lily/custos.cc
index 3ed96f6a99..92ea11c435 100644
--- a/lily/custos.cc
+++ b/lily/custos.cc
@@ -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 ");
diff --git a/lily/dots.cc b/lily/dots.cc
index 97ac61128e..cb46d269a0 100644
--- a/lily/dots.cc
+++ b/lily/dots.cc
@@ -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 "
diff --git a/lily/system-start-delimiter.cc b/lily/system-start-delimiter.cc
index 64450ec25e..1fe9456930 100644
--- a/lily/system-start-delimiter.cc
+++ b/lily/system-start-delimiter.cc
@@ -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 "