src/framework/*: improve the doxygen documentation (work in progress). This also...

[mlt] / src / framework / mlt_multitrack.h

diff --git a/src/framework/mlt_multitrack.h b/src/framework/mlt_multitrack.h
index 6323f56a9686cf110733782c8a7a7e6361108811..5d272b338b7a52ceeecf2de733d42daa66934276 100644 (file)
--- a/src/framework/mlt_multitrack.h
+++ b/src/framework/mlt_multitrack.h
@@ -1,7 +1,9 @@
-/*
- * 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
+ *
+ * Copyright (C) 2003-2008 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 +25,8 @@
 
 #include "mlt_producer.h"
 
-/** Private definition.
-*/
+/** \brief Track class
+ */
 
 struct mlt_track_s
 {
@@ -34,6 +36,11 @@ struct mlt_track_s
 
 typedef struct mlt_track_s *mlt_track;
 
+/** \brief Multitrack class
+ *
+ * \extends mlt_producer_s
+ */
+
 struct mlt_multitrack_s
 {
        /* We're extending producer here */
@@ -43,9 +50,6 @@ struct mlt_multitrack_s
        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 ) )