X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fgrob-interface-scheme.cc;fp=lily%2Fgrob-interface-scheme.cc;h=75755994d3282bf256ea4344f59835e76040920c;hb=e90f0536f9be39ada0bef0aeb0d275dec3b2fb5b;hp=0472d5bef6794aeee6d76e19761725ebe41b7440;hpb=a8c9e8a7ca320ab0df5fd32e717fd62cd7635ce6;p=lilypond.git diff --git a/lily/grob-interface-scheme.cc b/lily/grob-interface-scheme.cc index 0472d5bef6..75755994d3 100644 --- a/lily/grob-interface-scheme.cc +++ b/lily/grob-interface-scheme.cc @@ -1,9 +1,20 @@ /* - grob-interface-scheme.cc -- implement grob interface bindings. + This file is part of LilyPond, the GNU music typesetter. - source file of the GNU LilyPond music typesetter + Copyright (C) 2005--2011 Han-Wen Nienhuys - (c) 2005--2009 Han-Wen Nienhuys + LilyPond is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + LilyPond is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with LilyPond. If not, see . */ #include "lily-guile.hh" @@ -27,21 +38,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; }