X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fgrob-interface-scheme.cc;h=843420c9dff1b10d929774e0aeb09d564c6ff3ca;hb=47db9a3883d726ca53e2133a3b2298f78dd6a32e;hp=0472d5bef6794aeee6d76e19761725ebe41b7440;hpb=38d7d319eabc906e82fb42002678c6d42a23b6f7;p=lilypond.git

diff --git a/lily/grob-interface-scheme.cc b/lily/grob-interface-scheme.cc
index 0472d5bef6..843420c9df 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--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
-  (c) 2005--2009 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  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 <http://www.gnu.org/licenses/>.
 */
 
 #include "lily-guile.hh"
@@ -20,28 +31,31 @@ internal_add_interface (SCM a, SCM b, SCM c)
       all_ifaces = tab;
       scm_permanent_object (tab);
     }
-  
+
   SCM entry = scm_list_n (a, b, c, SCM_UNDEFINED);
 
   scm_hashq_set_x (all_ifaces, a, entry);
 }
 
 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.")
+           0, 0, 0, (),
+           "Return the hash table with all grob interface descriptions.")
 {
   return all_ifaces;
 }