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

[melted] / src / framework / mlt_tractor.h

diff --git a/src/framework/mlt_tractor.h b/src/framework/mlt_tractor.h
index b9f5545..52496a4 100644 (file)
--- a/src/framework/mlt_tractor.h
+++ b/src/framework/mlt_tractor.h
@@ -1,7 +1,9 @@
-/*
- * mlt_tractor.h -- tractor service class
- * Copyright (C) 2003-2004 Ushodaya Enterprises Limited
- * Author: Charles Yates <charles.yates@pandora.be>
+/**
+ * \file mlt_tractor.h
+ * \brief tractor 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,10 @@
 
 #include "mlt_producer.h"
 
-/** Private structure.
-*/
+/** \brief Tractor class
+ *
+ * \extends mlt_producer_s
+ */
 
 struct mlt_tractor_s
 {