X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fcontext-scheme.cc;h=96193f65e7ccbe05eec5d147c876ee4036334557;hb=5b4b0d6e9a197e8f9eb085b7c2ad78b8be3e5cfc;hp=4ff48155e3877de14239337a36ccbbc3eba1e66c;hpb=cbb205d40a19c0d2d9801031a63607e108a18038;p=lilypond.git diff --git a/lily/context-scheme.cc b/lily/context-scheme.cc index 4ff48155e3..96193f65e7 100644 --- a/lily/context-scheme.cc +++ b/lily/context-scheme.cc @@ -3,7 +3,7 @@ source file of the GNU LilyPond music typesetter - (c) 1998--2007 Jan Nieuwenhuizen + (c) 1998--2008 Jan Nieuwenhuizen Han-Wen Nienhuys */ @@ -13,9 +13,9 @@ LY_DEFINE (ly_context_id, "ly:context-id", 1, 0, 0, (SCM context), - "Return the id string of @var{context}, " - "i.e. for @code{\\context Voice = one .. } " - "return the string @code{one}.") + "Return the ID string of @var{context}," + " i.e., for @code{\\context Voice = one @dots{}}" + " return the string @code{one}.") { Context *tr = unsmob_context (context); @@ -26,9 +26,9 @@ LY_DEFINE (ly_context_id, "ly:context-id", LY_DEFINE (ly_context_name, "ly:context-name", 1, 0, 0, (SCM context), - "Return the name of @var{context}, " - "i.e. for @code{\\context Voice = one .. } " - "return the symbol @code{Voice}.") + "Return the name of @var{context}," + " i.e., for @code{\\context Voice = one @dots{}}" + " return the symbol @code{Voice}.") { LY_ASSERT_SMOB (Context, context, 1); @@ -39,8 +39,8 @@ LY_DEFINE (ly_context_name, "ly:context-name", LY_DEFINE (ly_context_grob_definition, "ly:context-grob-definition", 2, 0, 0, (SCM context, SCM name), - "Return the definition of @var{name} (a symbol) within @var{context} " - "as an alist") + "Return the definition of @var{name} (a symbol) within" + " @var{context} as an alist.") { Context *tr = unsmob_context (context); @@ -52,10 +52,10 @@ LY_DEFINE (ly_context_grob_definition, "ly:context-grob-definition", LY_DEFINE (ly_context_pushpop_property, "ly:context-pushpop-property", 3, 1, 0, (SCM context, SCM grob, SCM eltprop, SCM val), - "Do a single @code{\\override} or @code{\\revert} operation " - "in @var{context}. The grob definition @code{grob} is extended " - "with @code{eltprop} (if @var{val} is specified) " - "or reverted (if unspecified).") + "Do a single @code{\\override} or @code{\\revert} operation" + " in @var{context}. The grob definition @var{grob} is extended" + " with @var{eltprop} (if @var{val} is specified) or reverted" + " (if unspecified).") { Context *tg = unsmob_context (context); @@ -70,7 +70,7 @@ LY_DEFINE (ly_context_pushpop_property, "ly:context-pushpop-property", LY_DEFINE (ly_context_property, "ly:context-property", 2, 0, 0, (SCM c, SCM name), - "Return the value of @var{name} from context @var{c}") + "Return the value of @var{name} from context @var{c}.") { LY_ASSERT_SMOB (Context, c, 1); LY_ASSERT_TYPE (ly_is_symbol, name, 2); @@ -81,8 +81,8 @@ LY_DEFINE (ly_context_property, "ly:context-property", LY_DEFINE (ly_context_set_property_x, "ly:context-set-property!", 3, 0, 0, (SCM context, SCM name, SCM val), - "Set value of property @var{name} in context @var{context} " - "to @var{val}.") + "Set value of property @var{name} in context @var{context}" + " to @var{val}.") { LY_ASSERT_SMOB (Context, context, 1); LY_ASSERT_TYPE (ly_is_symbol, name, 2); @@ -96,8 +96,8 @@ LY_DEFINE (ly_context_set_property_x, "ly:context-set-property!", LY_DEFINE (ly_context_property_where_defined, "ly:context-property-where-defined", 2, 0, 0, (SCM context, SCM name), - "Return the context above @var{context} " - "where @var{name} is defined.") + "Return the context above @var{context}" + " where @var{name} is defined.") { LY_ASSERT_SMOB (Context, context, 1); LY_ASSERT_TYPE (ly_is_symbol, name, 2); @@ -141,8 +141,8 @@ LY_DEFINE (ly_context_parent, "ly:context-parent", /* FIXME: todo: should support translator IDs, and creation? */ LY_DEFINE (ly_context_find, "ly:context-find", 2, 0, 0, (SCM context, SCM name), - "Find a parent of @var{context} that has name or alias @var{name}. " - "Return @code{#f} if not found.") + "Find a parent of @var{context} that has name or alias @var{name}." + " Return @code{#f} if not found.") { LY_ASSERT_SMOB (Context, context, 1); LY_ASSERT_TYPE (ly_is_symbol, name, 2); @@ -160,7 +160,7 @@ LY_DEFINE (ly_context_find, "ly:context-find", LY_DEFINE (ly_context_now, "ly:context-now", 1, 0, 0, (SCM context), - "Return now-moment of context CONTEXT") + "Return @code{now-moment} of context @var{context}.") { LY_ASSERT_SMOB (Context, context, 1); Context *ctx = unsmob_context (context); @@ -169,7 +169,7 @@ LY_DEFINE (ly_context_now, "ly:context-now", LY_DEFINE (ly_context_event_source, "ly:context-event-source", 1, 0, 0, (SCM context), - "Return event-source of context CONTEXT") + "Return @code{event-source} of context @var{context}.") { LY_ASSERT_SMOB (Context, context, 1); Context *ctx = unsmob_context (context); @@ -178,7 +178,7 @@ LY_DEFINE (ly_context_event_source, "ly:context-event-source", LY_DEFINE (ly_context_events_below, "ly:context-events-below", 1, 0, 0, (SCM context), - "Return a stream-distributor that distributes all events\n" + "Return a @code{stream-distributor} that distributes all events" " from @var{context} and all its subcontexts.") { LY_ASSERT_SMOB (Context, context, 1);