Merge ../mlt

[melted] / src / framework / mlt_filter.h

diff --git a/src/framework/mlt_filter.h b/src/framework/mlt_filter.h
index c67c9ab..66e2e47 100644 (file)
--- a/src/framework/mlt_filter.h
+++ b/src/framework/mlt_filter.h
@@ -1,7 +1,10 @@
-/*
- * 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
+ *
+ * Copyright (C) 2003-2009 Ushodaya Enterprises Limited
+ * \author Charles Yates <charles.yates@pandora.be>
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
@@ -25,27 +28,27 @@
 
 /** \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 ) )