summaryrefslogtreecommitdiff
path: root/lily/grob-interface-scheme.cc
diff options
context:
space:
mode:
authorPatrick McCarty <pnorcks@gmail.com>2009-07-12 14:58:48 -0700
committerPatrick McCarty <pnorcks@gmail.com>2009-07-12 14:58:48 -0700
commit3653c7202740ac4e8de72fdea73c072d924899ac (patch)
tree457789d7c61b08bc905f32f3dc18013176607530 /lily/grob-interface-scheme.cc
parent2b5ff259db21a1b6847c773e2011dfcac187c583 (diff)
Docs: IR: Improve grob interface docstrings
Diffstat (limited to 'lily/grob-interface-scheme.cc')
-rw-r--r--lily/grob-interface-scheme.cc17
1 files changed, 10 insertions, 7 deletions
diff --git a/lily/grob-interface-scheme.cc b/lily/grob-interface-scheme.cc
index 0472d5bef6..635ce5fc08 100644
--- a/lily/grob-interface-scheme.cc
+++ b/lily/grob-interface-scheme.cc
@@ -27,21 +27,24 @@ internal_add_interface (SCM a, SCM b, SCM c)
}
LY_DEFINE (ly_add_interface, "ly:add-interface",
- 3, 0, 0, (SCM a, SCM b, SCM c),
- "Add an interface description.")
+ 3, 0, 0, (SCM iface, SCM desc, SCM props),
+ "Add a new grob interface. @var{iface} is the"
+ " interface name, @var{desc} is the interface"
+ " description, and @var{props} is the list of"
+ " user-settable properties for the interface.")
{
- LY_ASSERT_TYPE (ly_is_symbol, a, 1);
- LY_ASSERT_TYPE (scm_is_string, b, 2);
- LY_ASSERT_TYPE (ly_is_list, c, 3);
+ LY_ASSERT_TYPE (ly_is_symbol, iface, 1);
+ LY_ASSERT_TYPE (scm_is_string, desc, 2);
+ LY_ASSERT_TYPE (ly_is_list, props, 3);
- internal_add_interface (a,b,c);
+ internal_add_interface (iface, desc, props);
return SCM_UNSPECIFIED;
}
LY_DEFINE (ly_all_grob_interfaces, "ly:all-grob-interfaces",
0, 0, 0, (),
- "Get a hash table with all interface descriptions.")
+ "Return the hash table with all grob interface descriptions.")
{
return all_ifaces;
}