X-Git-Url: http://research.m1stereo.tv/gitweb?a=blobdiff_plain;f=src%2Fframework%2Fmlt_filter.h;h=66e2e471c007abe850d4485b923203f52c8fd6a0;hb=f4963a6aa07644399b273b5d2b1f9299c9047414;hp=d95a754c534cfc4522d4a25c637958ce38685bd4;hpb=f00476101550ec7d8e863f6516aa83bc1b524570;p=melted

diff --git a/src/framework/mlt_filter.h b/src/framework/mlt_filter.h
index d95a754..66e2e47 100644
--- a/src/framework/mlt_filter.h
+++ b/src/framework/mlt_filter.h
@@ -1,21 +1,24 @@
-/*
- * mlt_filter.h -- abstraction for all filter services
- * Copyright (C) 2003-2004 Ushodaya Enterprises Limited
- * Author: Charles Yates <charles.yates@pandora.be>
+/**
+ * \file mlt_filter.h
+ * \brief abstraction for all filter services
+ * \see mlt_filter_s
  *
- * 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) 2003-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_FILTER_H_
@@ -23,27 +26,29 @@
 
 #include "mlt_service.h"
 
-/** The interface definition for all filters.
-*/
+/** \brief Filter abstract service class
+ *
+ * A filter is a service that may modify the output of a single producer.
+ *
+ * \extends mlt_service_s
+ * \properties \em track the index of the track of a multitrack on which the filter is applied
+ */
 
 struct mlt_filter_s
 {
-	// We're implementing service here
+	/** We're implementing service here */
 	struct mlt_service_s parent;
 
-	// public virtual
+	/** public virtual */
 	void ( *close )( mlt_filter );
 
-	// protected filter method
+	/** protected filter method */
 	mlt_frame ( *process )( mlt_filter, mlt_frame );
 
-	// Protected
+	/** Protected */
 	void *child;
 };
 
-/** Public final methods
-*/
-
 #define MLT_FILTER_SERVICE( filter )		( &( filter )->parent )
 #define MLT_FILTER_PROPERTIES( filter )		MLT_SERVICE_PROPERTIES( MLT_FILTER_SERVICE( filter ) )