X-Git-Url: http://research.m1stereo.tv/gitweb?a=blobdiff_plain;f=src%2Fframework%2Fmlt_tractor.h;h=73e0715365273ab59a03b39aca42d4836ad4920d;hb=780b62679560f15e2201ae42a28de77346729b7e;hp=b9f5545d0973fe8412b69c855047efec6d233117;hpb=bf3264b9e340ba5c11cbf59835a8af3db94e0cc2;p=melted

diff --git a/src/framework/mlt_tractor.h b/src/framework/mlt_tractor.h
index b9f5545..73e0715 100644
--- a/src/framework/mlt_tractor.h
+++ b/src/framework/mlt_tractor.h
@@ -1,7 +1,10 @@
-/*
- * mlt_tractor.h -- tractor service class
- * Copyright (C) 2003-2004 Ushodaya Enterprises Limited
- * Author: Charles Yates <charles.yates@pandora.be>
+/**
+ * \file mlt_tractor.h
+ * \brief tractor service class
+ * \see mlt_tractor_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
@@ -23,8 +26,19 @@
 
 #include "mlt_producer.h"
 
-/** Private structure.
-*/
+/** \brief Tractor class
+ *
+ * The tractor is a convenience class that works with the field class
+ * to manage a multitrack, track filters, and transitions.
+ *
+ * \extends mlt_producer_s
+ * \properties \em multitrack holds a reference to the mulitrack object that a tractor manages
+ * \properties \em field holds a reference to the field object that a tractor manages
+ * \properties \em producer holds a reference to an encapsulated producer
+ * \properties \em global_feed a flag to indicate whether this tractor feeds to the consumer or stops here
+ * \properties \em global_queue is something for the data_feed functionality in the core module
+ * \properties \em data_queue is something for the data_feed functionality in the core module
+ */
 
 struct mlt_tractor_s
 {