[Gnash-commit] gnash ChangeLog server/builtin_function.h

[Sandro Santilli]

CVSROOT:        /sources/gnash
Module name:    gnash
Changes by:     Sandro Santilli <strk>  06/10/01 09:12:53

Modified files:
        .              : ChangeLog 
        server         : builtin_function.h 

Log message:
        * server/builtin_function.h: doxygen dox.

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/gnash/ChangeLog?cvsroot=gnash&r1=1.976&r2=1.977
http://cvs.savannah.gnu.org/viewcvs/gnash/server/builtin_function.h?cvsroot=gnash&r1=1.2&r2=1.3

Patches:
Index: ChangeLog
===================================================================
RCS file: /sources/gnash/gnash/ChangeLog,v
retrieving revision 1.976
retrieving revision 1.977
diff -u -b -r1.976 -r1.977
--- ChangeLog   30 Sep 2006 15:56:30 -0000      1.976
+++ ChangeLog   1 Oct 2006 09:12:53 -0000       1.977
@@ -1,3 +1,7 @@
+2006-10-01 Sandro Santilli  <address@hidden>
+
+       * server/builtin_function.h: doxygen dox.
+
 2006-09-30  Rob Savoye  <address@hidden>
 
        * macros/boost.m4: Look for Boost paths.

Index: server/builtin_function.h
===================================================================
RCS file: /sources/gnash/gnash/server/builtin_function.h,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -b -r1.2 -r1.3
--- server/builtin_function.h   26 Aug 2006 13:09:53 -0000      1.2
+++ server/builtin_function.h   1 Oct 2006 09:12:53 -0000       1.3
@@ -58,7 +58,17 @@
 
 public:
 
-       /// If 'func' parameter is NULL the function is not
+       /// Construct a builtin function/class
+       //
+       ///
+       /// @param func
+       ///     The C function to call when this as_function is invoked.
+       ///     For classes, the function pointer is the constructor.
+       ///
+       /// @param iface
+       ///     The interface of this class (will be inherited by
+       ///     instances of this class)
+       ///
        builtin_function(as_c_function_ptr func, as_object* iface)
                :
                as_function(iface),
@@ -66,7 +76,7 @@
        {
        }
 
-       /// Dispatch.
+       /// Invoke this function or this Class constructor
        virtual void operator()(const fn_call& fn)
        {
                assert(_func);