Add mlt_color and mlt_properties_get_color().

[mlt] / src / framework / mlt_multitrack.h

diff --git a/src/framework/mlt_multitrack.h b/src/framework/mlt_multitrack.h
index 6323f56a9686cf110733782c8a7a7e6361108811..427083c81719227bc1fda70de5b9773035b92c94 100644 (file)
--- a/src/framework/mlt_multitrack.h
+++ b/src/framework/mlt_multitrack.h
@@ -1,7 +1,10 @@
-/*
- * 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
+ *
+ * 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,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 ) )