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

[mlt] / src / framework / mlt_properties.h

diff --git a/src/framework/mlt_properties.h b/src/framework/mlt_properties.h
index 6ecb6d80e9a910aa845d426ff7ecb140f4ddd9f3..6fc81ad77acaf69cbac595cf9de38f294a273fae 100644 (file)
--- a/src/framework/mlt_properties.h
+++ b/src/framework/mlt_properties.h
@@ -1,8 +1,10 @@
-/*
- * mlt_properties.h -- base properties class
- * Copyright (C) 2003-2004 Ushodaya Enterprises Limited
- * Author: Charles Yates <charles.yates@pandora.be>
- * Contributor: Dan Dennedy <dan@dennedy.org>
+/**
+ * \file mlt_properties.h
+ * \brief Properties class declaration
+ *
+ * Copyright (C) 2003-2008 Ushodaya Enterprises Limited
+ * \author Charles Yates <charles.yates@pandora.be>
+ * \author Dan Dennedy <dan@dennedy.org>
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
@@ -26,21 +28,22 @@
 #include "mlt_events.h"
 #include <stdio.h>
 
-/** The properties base class defines the basic property propagation and
-       handling.
-*/
+/** \brief Properties class
+ *
+ * Properties is a combination list/dictionary of name/::mlt_property pairs.
+ * It is also a base class for many of the other MLT classes.
+ */
 
 struct mlt_properties_s
 {
-       void *child;
-       void *local;
+       void *child; /**< \private the object of a subclass */
+       void *local; /**< \private instance object */
+
+       /** the destructor virtual function */
        mlt_destructor close;
-       void *close_object;
+       void *close_object;  /**< the object supplied to the close virtual function */
 };
 
-/** Public interface.
-*/
-
 extern int mlt_properties_init( mlt_properties, void *child );
 extern mlt_properties mlt_properties_new( );
 extern mlt_properties mlt_properties_load( const char *file );