X-Git-Url: http://research.m1stereo.tv/gitweb?a=blobdiff_plain;f=src%2Fframework%2Fmlt_properties.h;h=c5e15cc153707ee832dff2099bdbf9ee10cb7086;hb=d5d878221c3123ef1d3a335dbc2b1878b3fdb983;hp=16ec1364695d9a24d103554f38c975998936660a;hpb=16f5e142927df67bd9a844ce56066d7497ca6069;p=melted

diff --git a/src/framework/mlt_properties.h b/src/framework/mlt_properties.h
index 16ec136..c5e15cc 100644
--- a/src/framework/mlt_properties.h
+++ b/src/framework/mlt_properties.h
@@ -1,21 +1,25 @@
-/*
- * mlt_properties.h -- base properties class
- * Copyright (C) 2003-2004 Ushodaya Enterprises Limited
- * Author: Charles Yates <charles.yates@pandora.be>
+/**
+ * \file mlt_properties.h
+ * \brief Properties class declaration
+ * \see mlt_properties_s
  *
- * 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-2009 Ushodaya Enterprises Limited
+ * \author Charles Yates <charles.yates@pandora.be>
+ * \author Dan Dennedy <dan@dennedy.org>
  *
- * 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_PROPERTIES_H_
@@ -25,21 +29,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 );
@@ -75,5 +80,8 @@ extern void mlt_properties_debug( mlt_properties self, const char *title, FILE *
 extern int mlt_properties_save( mlt_properties, const char * );
 extern int mlt_properties_dir_list( mlt_properties, const char *, const char *, int );
 extern void mlt_properties_close( mlt_properties self );
+extern int mlt_properties_is_sequence( mlt_properties self );
+extern mlt_properties mlt_properties_parse_yaml( const char *file );
+extern char *mlt_properties_serialise_yaml( mlt_properties self );
 
 #endif