]> git.donarmstrong.com Git - lilypond.git/commitdiff
docstrings for PaperColumn debugging stencils
authorKeith OHara <k-ohara5a5a@oco.net>
Sun, 14 Dec 2014 05:18:38 +0000 (21:18 -0800)
committerKeith OHara <k-ohara5a5a@oco.net>
Sat, 27 Dec 2014 04:26:01 +0000 (20:26 -0800)
lily/paper-column.cc
lily/separation-item.cc

index a7ca3116c0ce75ccbe88df7a8a96ed03975d6f58..f4721e92518f46f60ac101576d4f9940369ef1c1 100644 (file)
@@ -256,7 +256,13 @@ Paper_column::get_interface_extent (Grob *column, SCM iface, Axis a)
   to your score.
   Also, as of 2013-10-16 there's a switch in Frescobaldi that turns this on.
 */
-MAKE_SCHEME_CALLBACK (Paper_column, print, 1);
+MAKE_DOCUMENTED_SCHEME_CALLBACK (Paper_column, print, 1,
+                                 "Optional stencil for @code{PaperColumn} or"
+                                 "@code{NonMusicalPaperColumn}.\n"
+                                 "Draws the @code{rank number} of each column,"
+                                 " its moment in time, a blue arrow showing the"
+                                 " ideal distance, and a red arrow showing the"
+                                 " minimum distance between columns.");
 SCM
 Paper_column::print (SCM p)
 {
index 6b50b117ee02540bce0d887a3e4752be6337d02f..832694adf5d8d99d8a917c23cce249d1697720a1 100644 (file)
@@ -186,7 +186,15 @@ Separation_item::boxes (Grob *me, Grob *left)
   return out;
 }
 
-MAKE_SCHEME_CALLBACK (Separation_item, print, 1)
+MAKE_DOCUMENTED_SCHEME_CALLBACK (Separation_item, print, 1,
+                                 "Optional stencil for @code{PaperColumn} or"
+                                 "@code{NonMusicalPaperColumn}.\n"
+                                 "Draws the @code{horizontal-skylines} of each"
+                                 " @code{PaperColumn}, showing the shapes used"
+                                 " to determine the minimum distances between"
+                                 " @code{PaperColumns} at the note-spacing step,"
+                                 " before staves have been spaced (vertically)"
+                                 " on the page.")
 SCM
 Separation_item::print (SCM smob)
 {