X-Git-Url: http://research.m1stereo.tv/gitweb?a=blobdiff_plain;f=src%2Fframework%2Fmlt_multitrack.h;h=427083c81719227bc1fda70de5b9773035b92c94;hb=d5d878221c3123ef1d3a335dbc2b1878b3fdb983;hp=f0eaa70eccb846a8ddefdecda73d786b15935832;hpb=f00476101550ec7d8e863f6516aa83bc1b524570;p=melted

diff --git a/src/framework/mlt_multitrack.h b/src/framework/mlt_multitrack.h
index f0eaa70..427083c 100644
--- a/src/framework/mlt_multitrack.h
+++ b/src/framework/mlt_multitrack.h
@@ -1,21 +1,24 @@
-/*
- * mlt_multitrack.h -- multitrack service class
- * Copyright (C) 2003-2004 Ushodaya Enterprises Limited
- * Author: Charles Yates <charles.yates@pandora.be>
+/**
+ * \file mlt_multitrack.h
+ * \brief multitrack service class
+ * \see mlt_multitrack_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_MULITRACK_H_
@@ -23,8 +26,8 @@
 
 #include "mlt_producer.h"
 
-/** Private definition.
-*/
+/** \brief Track class used by mlt_multitrack_s
+ */
 
 struct mlt_track_s
 {
@@ -34,18 +37,23 @@ struct mlt_track_s
 
 typedef struct mlt_track_s *mlt_track;
 
+/** \brief Multitrack class
+ *
+ * A multitrack is a parallel container of producers that acts a single producer.
+ *
+ * \extends mlt_producer_s
+ * \properties \em log_id not currently used, but sets it to "mulitrack"
+ */
+
 struct mlt_multitrack_s
 {
-	// We're extending producer here
+	/** We're extending producer here */
 	struct mlt_producer_s parent;
 	mlt_track *list;
 	int size;
 	int count;
 };
 
-/** Public final methods
-*/
-
 #define MLT_MULTITRACK_PRODUCER( multitrack )	( &( multitrack )->parent )
 #define MLT_MULTITRACK_SERVICE( multitrack )	MLT_PRODUCER_SERVICE( MLT_MULTITRACK_PRODUCER( multitrack ) )
 #define MLT_MULTITRACK_PROPERTIES( multitrack )	MLT_SERVICE_PROPERTIES( MLT_MULTITRACK_SERVICE( multitrack ) )