[PATCH] Docs: IR: fix documentation of 'style values

[ Thread Index | Date Index | More lilynet.net/frogs Archives ]


* Document the engraver that creates KeyCancellation

* Add missing 'style values for time-signature
  and note-head interfaces

* The line-spanner interface does not contain 'style

* Key interface no longer uses 'style

* Note-name interface does not use 'style

* Key-signature interface no longer uses 'style;
  'glyph-name-alist is used instead.

Signed-off-by: Patrick McCarty <pnorcks@xxxxxxxxx>
---
 lily/key-engraver.cc            |    1 +
 lily/key-signature-interface.cc |    8 --------
 lily/line-spanner.cc            |    6 +-----
 lily/note-head.cc               |    4 +++-
 lily/time-signature.cc          |    9 +++++----
 scm/define-grob-interfaces.scm  |    2 +-
 6 files changed, 11 insertions(+), 19 deletions(-)

diff --git a/lily/key-engraver.cc b/lily/key-engraver.cc
index 87040e0..1123455 100644
--- a/lily/key-engraver.cc
+++ b/lily/key-engraver.cc
@@ -211,6 +211,7 @@ ADD_TRANSLATOR (Key_engraver,
 		"Engrave a key signature.",
 
 		/* create */
+		"KeyCancellation "
 		"KeySignature ",
 		
 		/* read */
diff --git a/lily/key-signature-interface.cc b/lily/key-signature-interface.cc
index 58f0abd..d0f3026 100644
--- a/lily/key-signature-interface.cc
+++ b/lily/key-signature-interface.cc
@@ -36,13 +36,6 @@ Key_signature_interface::print (SCM smob)
 
   Real inter = Staff_symbol_referencer::staff_space (me) / 2.0;
 
-  SCM scm_style = me->get_property ("style");
-  string style;
-  if (scm_is_symbol (scm_style))
-    style = ly_symbol2string (scm_style);
-  else
-    style = "";
-
   Stencil mol;
 
   SCM c0s = me->get_property ("c0-position");
@@ -128,5 +121,4 @@ ADD_INTERFACE (Key_signature_interface,
 	       "glyph-name-alist "
 	       "padding "
 	       "padding-pairs "
-	       "style "
 	       );
diff --git a/lily/line-spanner.cc b/lily/line-spanner.cc
index d9c5f56..b191519 100644
--- a/lily/line-spanner.cc
+++ b/lily/line-spanner.cc
@@ -349,11 +349,7 @@ Line_spanner::print (SCM smob)
 
 ADD_INTERFACE (Line_spanner,
 	       "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}, @code{dotted-line} or"
-	       " @code{zigzag}.",
+	       " glissandi.",
 
 	       /* properties */
 	       "bound-details "
diff --git a/lily/note-head.cc b/lily/note-head.cc
index 1a9196e..3f446ee 100644
--- a/lily/note-head.cc
+++ b/lily/note-head.cc
@@ -143,7 +143,9 @@ Note_head::calc_stem_attachment (SCM smob)
 
 
 ADD_INTERFACE (Note_head,
-	       "Note head.",
+	       "A note head.  There are many possible values for"
+	       " @code{style}.  For a complete list, see"
+	       " @ruser{Note head styles}.",
 
 	       /* properties */
 	       "note-names "
diff --git a/lily/time-signature.cc b/lily/time-signature.cc
index 3635a84..9beda76 100644
--- a/lily/time-signature.cc
+++ b/lily/time-signature.cc
@@ -127,7 +127,8 @@ ADD_INTERFACE (Time_signature,
 	       "@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"
+	       "  All other time signatures are written with two digits."
+	       "  The value @code{default} is equivalent to @code{C}.\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"
@@ -139,9 +140,9 @@ ADD_INTERFACE (Time_signature,
 	       "@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"
-	       "See also the test-file @file{input/test/time.ly}.",
+	       "@item numbered\n"
+	       "All time signatures are typeset with two digits.\n"
+	       "@end table",
 
 	       /* properties */
 	       "fraction "
diff --git a/scm/define-grob-interfaces.scm b/scm/define-grob-interfaces.scm
index f62fa88..a2ee152 100644
--- a/scm/define-grob-interfaces.scm
+++ b/scm/define-grob-interfaces.scm
@@ -109,7 +109,7 @@ note)."
 (ly:add-interface
  'note-name-interface
  "Note names."
- '(style))
+ '())
 
 (ly:add-interface
  'only-prebreak-interface
-- 
1.6.1.1


--PNTmBPCT7hxwcZjr--

---

----
Join the Frogs!


Mail converted by MHonArc 2.6.19+ http://listengine.tuxfamily.org/