]> git.sesse.net Git - mlt/commitdiff
Various documentation and copyright fixes and updates.
authorDan Dennedy <dan@dennedy.org>
Fri, 31 May 2013 05:04:48 +0000 (22:04 -0700)
committerDan Dennedy <dan@dennedy.org>
Fri, 31 May 2013 23:58:13 +0000 (16:58 -0700)
src/framework/mlt_animation.c
src/framework/mlt_animation.h
src/framework/mlt_frame.c
src/framework/mlt_frame.h
src/framework/mlt_properties.c
src/framework/mlt_properties.h
src/framework/mlt_property.c
src/framework/mlt_property.h
src/framework/mlt_types.h

index 8d15a5762bf9188f28674df5f5d6e323535e79cc..7468bb586957258681af7b0520ea804dd5ca924a 100644 (file)
@@ -1,8 +1,11 @@
-/*
- * mlt_animation.c -- provides the property animation API
+/**
+ * \file mlt_animation.c
+ * \brief Property Animation class definition
+ * \see mlt_animaton_s
+ *
  * Copyright (C) 2004-2013 Ushodaya Enterprises Limited
- * Author: Charles Yates <charles.yates@pandora.be>
- * Author: Dan Dennedy <dan@dennedy.org>
+ * \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
index a73e1930c7aab1d8c7969dbedc4e4ce7e9ba4e09..4dbd60dcb2f60e210c77021e6bb3b7894eb6c95c 100644 (file)
@@ -1,8 +1,11 @@
-/*
- * mlt_animation.h -- provides the property animation API
+/**
+ * \file mlt_animation.h
+ * \brief Property Animation class declaration
+ * \see mlt_animaton_s
+ *
  * Copyright (C) 2004-2013 Ushodaya Enterprises Limited
- * Author: Charles Yates <charles.yates@pandora.be>
- * Author: Dan Dennedy <dan@dennedy.org>
+ * \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
index 7c8b5f83145a30a26cf429b223d955f9ea3c5905..5bd40c4c7c4bb24dd6d376125727347476cd4d6b 100644 (file)
@@ -3,8 +3,9 @@
  * \brief interface for all frame classes
  * \see mlt_frame_s
  *
- * Copyright (C) 2003-2009 Ushodaya Enterprises Limited
+ * Copyright (C) 2003-2013 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
@@ -183,7 +184,7 @@ int mlt_frame_set_position( mlt_frame self, mlt_position value )
  *
  * \public \memberof mlt_frame_s
  * \param self a frame
- * \param the get_image callback
+ * \param get_image the get_image callback
  * \return true if error
  */
 
index 74e63b8007143d32b1ab6fba2c72827e08cdd012..ae45e7be2ba3ff38bdfe4ef649bca62ca67a4df3 100644 (file)
@@ -3,8 +3,9 @@
  * \brief interface for all frame classes
  * \see mlt_frame_s
  *
- * Copyright (C) 2003-2009 Ushodaya Enterprises Limited
+ * Copyright (C) 2003-2013 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
index 7fddb5990edac9d2079f11f9b7a378419d2a41e9..c1f3747c7d9ef6b279ea103a40dea54fa084b6b1 100644 (file)
@@ -3,7 +3,7 @@
  * \brief Properties class definition
  * \see mlt_properties_s
  *
- * Copyright (C) 2003-2009 Ushodaya Enterprises Limited
+ * Copyright (C) 2003-2013 Ushodaya Enterprises Limited
  * \author Charles Yates <charles.yates@pandora.be>
  * \author Dan Dennedy <dan@dennedy.org>
  *
@@ -2130,7 +2130,7 @@ mlt_color mlt_properties_get_color( mlt_properties self, const char* name )
  * \public \memberof mlt_properties_s
  * \param self a properties list
  * \param name the property to set
- * \param value the color
+ * \param color the color
  * \return true if error
  */
 
index d276a237ce14bacd5f2c496a8e6b0002e55dd5e4..7c4900d35f179bcac8258b1716d51cfcfdb0edc4 100644 (file)
@@ -3,7 +3,7 @@
  * \brief Properties class declaration
  * \see mlt_properties_s
  *
- * Copyright (C) 2003-2011 Ushodaya Enterprises Limited
+ * Copyright (C) 2003-2013 Ushodaya Enterprises Limited
  * \author Charles Yates <charles.yates@pandora.be>
  * \author Dan Dennedy <dan@dennedy.org>
  *
index 69161dfd66eb0c21db8b5aeb90e5aa1d48b68120..d9932dab3111703eaf12b1351ebd2f7657f69b34 100644 (file)
@@ -3,8 +3,9 @@
  * \brief Property class definition
  * \see mlt_property_s
  *
- * Copyright (C) 2003-2009 Ushodaya Enterprises Limited
+ * Copyright (C) 2003-2013 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
index b6a0d167fd0c430430847fd2e33b297c5d7861b5..c951762ddb44acf1e784d62fea49c68fea598036 100644 (file)
@@ -3,8 +3,9 @@
  * \brief Property class declaration
  * \see mlt_property_s
  *
- * Copyright (C) 2003-2009 Ushodaya Enterprises Limited
+ * Copyright (C) 2003-2013 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
index bb9e2c654d25ff23320f4607729ec1f717ed29ea..26e410c899acb0a1a6941448b5906d51031a156d 100644 (file)
@@ -123,6 +123,8 @@ typedef double mlt_position;
 typedef int32_t mlt_position;
 #endif
 
+/** A rectangle type with coordinates, size, and opacity */
+
 typedef struct {
        double x; /**< X coordinate */
        double y; /**< Y coordinate */
@@ -132,6 +134,8 @@ typedef struct {
 }
 mlt_rect;
 
+/** A tuple of color components */
+
 typedef struct {
        uint8_t r; /**< red */
        uint8_t g; /**< green */