From d3f5470a6268a580ec9e1ba7fd8eb21ca06f80b5 Mon Sep 17 00:00:00 2001 From: Keith OHara Date: Sat, 13 Dec 2014 21:18:38 -0800 Subject: [PATCH] docstrings for PaperColumn debugging stencils --- lily/paper-column.cc | 8 +++++++- lily/separation-item.cc | 10 +++++++++- 2 files changed, 16 insertions(+), 2 deletions(-) diff --git a/lily/paper-column.cc b/lily/paper-column.cc index a7ca3116c0..f4721e9251 100644 --- a/lily/paper-column.cc +++ b/lily/paper-column.cc @@ -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) { diff --git a/lily/separation-item.cc b/lily/separation-item.cc index 6b50b117ee..832694adf5 100644 --- a/lily/separation-item.cc +++ b/lily/separation-item.cc @@ -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) { -- 2.39.5