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

[mlt] / src / framework / mlt_transition.h

diff --git a/src/framework/mlt_transition.h b/src/framework/mlt_transition.h
index 7b51de861c786bc6bd447fe39ed30dd1dcb2a65c..0a38157b619a0e4b0096a81f21c4a3b3c6bdb992 100644 (file)
--- a/src/framework/mlt_transition.h
+++ b/src/framework/mlt_transition.h
@@ -1,7 +1,9 @@
-/*
- * mlt_transition.h -- abstraction for all transition services
- * Copyright (C) 2003-2004 Ushodaya Enterprises Limited
- * Author: Charles Yates <charles.yates@pandora.be>
+/**
+ * \file mlt_transition.h
+ * \brief abstraction for all transition services
+ *
+ * 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,10 @@
 
 #include "mlt_service.h"
 
-/** The interface definition for all transitions.
-*/
+/** \brief Transition abstract service class
+ *
+ * \extends mlt_service_s
+ */
 
 struct mlt_transition_s
 {
@@ -39,10 +43,10 @@ struct mlt_transition_s
 
        /* Protected */
        void *child;
-       
+
        /* track and in/out points */
        mlt_service producer;
-       
+
        /* Private */
        mlt_frame *frames;
        int held;