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

[melted] / src / framework / mlt_transition.h

diff --git a/src/framework/mlt_transition.h b/src/framework/mlt_transition.h
index 9db26b3..0a38157 100644 (file)
--- a/src/framework/mlt_transition.h
+++ b/src/framework/mlt_transition.h
@@ -1,21 +1,23 @@
-/*
- * 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
  *
- * 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-2008 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_TRANSITION_H_
@@ -23,27 +25,29 @@
 
 #include "mlt_service.h"
 
-/** The interface definition for all transitions.
-*/
+/** \brief Transition abstract service class
+ *
+ * \extends mlt_service_s
+ */
 
 struct mlt_transition_s
 {
-       // We're implementing service here
+       /* We're implementing service here */
        struct mlt_service_s parent;
 
-       // public virtual
+       /* public virtual */
        void ( *close )( mlt_transition );
 
-       // protected transition method
+       /* protected transition method */
        mlt_frame ( *process )( mlt_transition, mlt_frame, mlt_frame );
 
-       // Protected
+       /* Protected */
        void *child;
-       
-       // track and in/out points
+
+       /* track and in/out points */
        mlt_service producer;
-       
-       // Private
+
+       /* Private */
        mlt_frame *frames;
        int held;
 };