Add doxygen documentation for mlt_profile, mlt_pool, mlt_repository, and mlt_factory.

[mlt] / src / framework / mlt_events.h

diff --git a/src/framework/mlt_events.h b/src/framework/mlt_events.h
index 70457712817efdcf6eb46b52c1d52f2eebdd968b..850016091164c54b5c8d73f530b6953ad7245cc6 100644 (file)
--- a/src/framework/mlt_events.h
+++ b/src/framework/mlt_events.h
@@ -1,21 +1,24 @@
-/*
- * mlt_events.h -- event handling 
- * Copyright (C) 2004-2005 Ushodaya Enterprises Limited
- * Author: Charles Yates <charles.yates@pandora.be>
+/**
+ * \file mlt_events.h
+ * \brief event handling
+ * \see mlt_events_struct
  *
- * This program 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 2 of the License, or
- * (at your option) any later version.
+ * Copyright (C) 2004-2009 Ushodaya Enterprises Limited
+ * \author Charles Yates <charles.yates@pandora.be>
  *
- * This program is distributed in the hope that it will be useful,
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library 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.
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
  *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software Foundation,
- * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
 
 #ifndef _MLT_EVENTS_H_
@@ -23,8 +26,21 @@
 
 #include "mlt_types.h"
 
+#if GCC_VERSION >= 40000
+typedef void ( *mlt_transmitter )( void *, ... );
+typedef void ( *mlt_listener )( void *, ... );
+#else
+/** callback function to send an event message
+ *
+ */
 typedef void ( *mlt_transmitter )( );
+/** event handler when receiving an event message
+ * \param the properties object on which the event was registered
+ * \param an opaque pointer to a service or really an object
+ * \param variable args supplied by the transmitter
+ */
 typedef void ( *mlt_listener )( );
+#endif
 
 extern void mlt_events_init( mlt_properties self );
 extern int mlt_events_register( mlt_properties self, char *id, mlt_transmitter transmitter );