X-Git-Url: http://research.m1stereo.tv/gitweb?a=blobdiff_plain;f=src%2Fframework%2Fmlt_field.c;h=c988ae6ea4584933e1f337aa296c5e06cfd665ea;hb=f4963a6aa07644399b273b5d2b1f9299c9047414;hp=924eee9486902d9862b028f48a2bb86f4b43029d;hpb=6093b927acb829f21d7bc48c25b584bcc21af047;p=melted

diff --git a/src/framework/mlt_field.c b/src/framework/mlt_field.c
index 924eee9..c988ae6 100644
--- a/src/framework/mlt_field.c
+++ b/src/framework/mlt_field.c
@@ -1,7 +1,10 @@
-/*
- * mlt_field.c -- A field for planting multiple transitions and filters
- * Copyright (C) 2003-2004 Ushodaya Enterprises Limited
- * Author: Charles Yates <charles.yates@pandora.be>
+/**
+ * \file mlt_field.c
+ * \brief a field for planting multiple transitions and filters
+ * \see mlt_field_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
@@ -28,25 +31,28 @@
 #include <stdlib.h>
 #include <string.h>
 
-/** Private structures.
-*/
+/** \brief Field class
+ *
+ * The field is a convenience class that works with the tractor and multitrack classes to manage track filters and transitions.
+ */
 
 struct mlt_field_s
 {
-	// This is the producer we're connected to
+	/// This is the producer we're connected to
 	mlt_service producer;
 
-	// Multitrack
+	/// Multitrack
 	mlt_multitrack multitrack;
 
-	// Tractor
+	/// Tractor
 	mlt_tractor tractor;
 };
 
-/** Constructor.
-	
-  	We construct a multitrack and a tractor here.
-*/
+/** Construct a field, mulitrack, and tractor.
+ *
+ * \public \memberof mlt_field_s
+ * \return a new field
+ */
 
 mlt_field mlt_field_init( )
 {
@@ -73,6 +79,14 @@ mlt_field mlt_field_init( )
 	return this;
 }
 
+/** Construct a field and initialize with supplied multitrack and tractor.
+ *
+ * \public \memberof mlt_field_s
+ * \param multitrack a multitrack
+ * \param tractor a tractor
+ * \return a new field
+ */
+
 mlt_field mlt_field_new( mlt_multitrack multitrack, mlt_tractor tractor )
 {
 	// Initialise the field
@@ -99,15 +113,23 @@ mlt_field mlt_field_new( mlt_multitrack multitrack, mlt_tractor tractor )
 }
 
 /** Get the service associated to this field.
-*/
+ *
+ * \public \memberof mlt_field_s
+ * \param this a field
+ * \return the tractor as a service
+ */
 
 mlt_service mlt_field_service( mlt_field this )
 {
 	return MLT_TRACTOR_SERVICE( this->tractor );
 }
 
-/** Get the multi track.
-*/
+/** Get the multitrack.
+ *
+ * \public \memberof mlt_field_s
+ * \param this a field
+ * \return the multitrack
+ */
 
 mlt_multitrack mlt_field_multitrack( mlt_field this )
 {
@@ -115,7 +137,11 @@ mlt_multitrack mlt_field_multitrack( mlt_field this )
 }
 
 /** Get the tractor.
-*/
+ *
+ * \public \memberof mlt_field_s
+ * \param this a field
+ * \return the tractor
+ */
 
 mlt_tractor mlt_field_tractor( mlt_field this )
 {
@@ -123,7 +149,11 @@ mlt_tractor mlt_field_tractor( mlt_field this )
 }
 
 /** Get the properties associated to this field.
-*/
+ *
+ * \public \memberof mlt_field_s
+ * \param this a field
+ * \return a properties list
+ */
 
 mlt_properties mlt_field_properties( mlt_field this )
 {
@@ -131,7 +161,13 @@ mlt_properties mlt_field_properties( mlt_field this )
 }
 
 /** Plant a filter.
-*/
+ *
+ * \public \memberof mlt_field_s
+ * \param this a field
+ * \param that a filter
+ * \param track the track index
+ * \return true if there was an error
+ */
 
 int mlt_field_plant_filter( mlt_field this, mlt_filter that, int track )
 {
@@ -155,7 +191,14 @@ int mlt_field_plant_filter( mlt_field this, mlt_filter that, int track )
 }
 
 /** Plant a transition.
-*/
+ *
+ * \public \memberof mlt_field_s
+ * \param this a field
+ * \param that a transition
+ * \param a_track input A's track index
+ * \param b_track input B's track index
+ * \return true if there was an error
+ */
 
 int mlt_field_plant_transition( mlt_field this, mlt_transition that, int a_track, int b_track )
 {
@@ -179,7 +222,10 @@ int mlt_field_plant_transition( mlt_field this, mlt_transition that, int a_track
 }
 
 /** Close the field.
-*/
+ *
+ * \public \memberof mlt_field_s
+ * \param this a field
+ */
 
 void mlt_field_close( mlt_field this )
 {
@@ -191,6 +237,13 @@ void mlt_field_close( mlt_field this )
 	}
 }
 
+/** Remove a filter or transition from the field.
+ *
+ * \public \memberof mlt_field_s
+ * \param self a field
+ * \param service the filter or transition to remove
+ */
+
 void mlt_field_disconnect_service( mlt_field self, mlt_service service )
 {
 	mlt_service p = mlt_service_producer( service );