X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Ffont-metric-scheme.cc;h=7cdffddfd1c914624cb47c8dab8968b3aad5ada1;hb=5b4b0d6e9a197e8f9eb085b7c2ad78b8be3e5cfc;hp=aa49a29e23ee333607ae290880c0f69165469579;hpb=c3ff1c6cd20e15e9036ee7120012e05b1d62a46d;p=lilypond.git diff --git a/lily/font-metric-scheme.cc b/lily/font-metric-scheme.cc index aa49a29e23..7cdffddfd1 100644 --- a/lily/font-metric-scheme.cc +++ b/lily/font-metric-scheme.cc @@ -3,7 +3,7 @@ source file of the GNU LilyPond music typesetter - (c) 2005--2007 Han-Wen Nienhuys + (c) 2005--2008 Han-Wen Nienhuys */ #include "font-metric.hh" @@ -15,9 +15,14 @@ LY_DEFINE (ly_font_get_glyph, "ly:font-get-glyph", 2, 0, 0, (SCM font, SCM name), - "Return a Stencil from @var{font} for the glyph named @var{name}. " - "@var{font} must be available as an AFM file. If the glyph " - "is not available, return @code{#f}.") + "Return a stencil from @var{font} for the glyph named @var{name}." + " If the glyph is not available, return an empty stencil.\n" + "\n" + "Note that this command can only be used to access glyphs from" + " fonts loaded with @code{ly:system-font-load}; currently, this" + " means either the Emmentaler or Aybabtu fonts, corresponding" + " to the font encodings @code{fetaMusic} and @code{fetaBraces}," + " respectively.") { Font_metric *fm = unsmob_metrics (font); LY_ASSERT_SMOB (Font_metric, font, 1); @@ -32,8 +37,14 @@ LY_DEFINE (ly_font_get_glyph, "ly:font-get-glyph", LY_DEFINE (ly_get_glyph, "ly:get-glyph", 2, 0, 0, (SCM font, SCM index), - "Retrieve a Stencil for the glyph numbered @var{index} " - "in @var{font}.") + "Retrieve a stencil for the glyph numbered @var{index}" + " in @var{font}.\n" + "\n" + "Note that this command can only be used to access glyphs from" + " fonts loaded with @code{ly:system-font-load}; currently, this" + " means either the Emmentaler or Aybabtu fonts, corresponding" + " to the font encodings @code{fetaMusic} and @code{fetaBraces}," + " respectively.") { Font_metric *fm = unsmob_metrics (font); LY_ASSERT_SMOB (Font_metric, font, 1); @@ -45,7 +56,13 @@ LY_DEFINE (ly_get_glyph, "ly:get-glyph", LY_DEFINE (ly_font_glyph_name_to_index, "ly:font-glyph-name-to-index", 2, 0, 0, (SCM font, SCM name), - "Return the index for @var{name} in @var{font}.") + "Return the index for @var{name} in @var{font}.\n" + "\n" + "Note that this command can only be used to access glyphs from" + " fonts loaded with @code{ly:system-font-load}; currently, this" + " means either the Emmentaler or Aybabtu fonts, corresponding" + " to the font encodings @code{fetaMusic} and @code{fetaBraces}," + " respectively.") { Font_metric *fm = unsmob_metrics (font); LY_ASSERT_SMOB (Font_metric, font, 1); @@ -57,7 +74,13 @@ LY_DEFINE (ly_font_glyph_name_to_index, "ly:font-glyph-name-to-index", LY_DEFINE (ly_font_index_to_charcode, "ly:font-index-to-charcode", 2, 0, 0, (SCM font, SCM index), - "Return the character code for @var{index} @var{font}.") + "Return the character code for @var{index} in @var{font}.\n" + "\n" + "Note that this command can only be used to access glyphs from" + " fonts loaded with @code{ly:system-font-load}; currently, this" + " means either the Emmentaler or Aybabtu fonts, corresponding" + " to the font encodings @code{fetaMusic} and @code{fetaBraces}," + " respectively.") { Font_metric *fm = unsmob_metrics (font); LY_ASSERT_SMOB (Font_metric, font, 1); @@ -69,7 +92,13 @@ LY_DEFINE (ly_font_index_to_charcode, "ly:font-index-to-charcode", LY_DEFINE (ly_font_glyph_name_to_charcode, "ly:font-glyph-name-to-charcode", 2, 0, 0, (SCM font, SCM name), - "Return the character code for glyph @var{name} in @var{font}.") + "Return the character code for glyph @var{name} in @var{font}.\n" + "\n" + "Note that this command can only be used to access glyphs from" + " fonts loaded with @code{ly:system-font-load}; currently, this" + " means either the Emmentaler or Aybabtu fonts, corresponding" + " to the font encodings @code{fetaMusic} and @code{fetaBraces}," + " respectively.") { Font_metric *fm = unsmob_metrics (font); LY_ASSERT_SMOB (Font_metric, font, 1); @@ -81,9 +110,9 @@ LY_DEFINE (ly_font_glyph_name_to_charcode, "ly:font-glyph-name-to-charcode", LY_DEFINE (ly_text_dimension, "ly:text-dimension", 2, 0, 0, (SCM font, SCM text), - "Given the font metric in @var{font} and the string @var{text}, " - "compute the extents of that text in that font. " - "The return value is a pair of number-pairs.") + "Given the font metric in @var{font} and the string @var{text}," + " compute the extents of that text in that font. The return" + " value is a pair of number-pairs.") { Box b; Modified_font_metric *fm = dynamic_cast @@ -103,8 +132,8 @@ LY_DEFINE (ly_text_dimension, "ly:text-dimension", LY_DEFINE (ly_font_file_name, "ly:font-file-name", 1, 0, 0, (SCM font), - "Given the font metric @var{font}, " - "return the corresponding file name.") + "Given the font metric @var{font}," + " return the corresponding file name.") { LY_ASSERT_SMOB (Font_metric, font, 1); @@ -117,8 +146,8 @@ LY_DEFINE (ly_font_file_name, "ly:font-file-name", LY_DEFINE (ly_font_name, "ly:font-name", 1, 0, 0, (SCM font), - "Given the font metric @var{font}, " - "return the corresponding name.") + "Given the font metric @var{font}," + " return the corresponding name.") { LY_ASSERT_SMOB (Font_metric, font, 1); Font_metric *fm = unsmob_metrics (font); @@ -128,8 +157,8 @@ LY_DEFINE (ly_font_name, "ly:font-name", LY_DEFINE (ly_font_magnification, "ly:font-magnification", 1, 0, 0, (SCM font), - "Given the font metric @var{font}, return the " - "magnification, relative to the current output-scale.") + "Given the font metric @var{font}, return the" + " magnification, relative to the current output-scale.") { LY_ASSERT_SMOB (Font_metric, font, 1); @@ -139,8 +168,8 @@ LY_DEFINE (ly_font_magnification, "ly:font-magnification", 1, 0, 0, LY_DEFINE (ly_font_design_size, "ly:font-design-size", 1, 0, 0, (SCM font), - "Given the font metric @var{font}, return the " - "design size, relative to the current output-scale.") + "Given the font metric @var{font}, return the" + " design size, relative to the current output-scale.") { LY_ASSERT_SMOB (Font_metric, font, 1);