#ifndef _MLT_H_
#define _MLT_H_
+/** \mainpage MLT API Reference Documentation
+ * \par
+ * We recommend that you look in <a href="annotated.html"><b>Data Structures</b></a>
+ * or <a href="files.html"><b>Files</b></a>.
+ * \par
+ * Additional documentation about MLT, in general, can be found on the
+ * <a href="http://www.mltframework.org/bin/view/MLT/Documentation">MLT website</a>.
+ */
+
#ifdef __cplusplus
extern "C"
{
/**
* \file mlt_animation.c
* \brief Property Animation class definition
- * \see mlt_animaton_s
+ * \see mlt_animation_s
*
* Copyright (C) 2004-2013 Ushodaya Enterprises Limited
* \author Charles Yates <charles.yates@pandora.be>
/**
* \file mlt_animation.h
* \brief Property Animation class declaration
- * \see mlt_animaton_s
+ * \see mlt_animation_s
*
* Copyright (C) 2004-2013 Ushodaya Enterprises Limited
* \author Charles Yates <charles.yates@pandora.be>
-/*
- * mlt_geometry.c -- provides the geometry API
+/**
+ * \file mlt_geometry.c
+ * \brief geometry animation API (deprecated)
+ * \deprecated use mlt_animation_s instead
+ *
* Copyright (C) 2004-2005 Ushodaya Enterprises Limited
- * Author: Charles Yates <charles.yates@pandora.be>
+ * \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
#include <stdlib.h>
#include <string.h>
+/** private part of geometry animation item (deprecated)
+ * \deprecated use mlt_animation_s instead
+ */
+
typedef struct geometry_item_s
{
struct mlt_geometry_item_s data;
}
*geometry_item;
+/** private part of geometry object (deprecated)
+ * \deprecated use mlt_animation_s instead
+ */
+
typedef struct
{
char *data;
-/*
- * mlt_geometry.h -- provides the geometry API
+/**
+ * \file mlt_geometry.h
+ * \brief geometry animation API (deprecated)
+ * \deprecated use mlt_animation_s instead
+ *
* Copyright (C) 2004-2005 Ushodaya Enterprises Limited
- * Author: Charles Yates <charles.yates@pandora.be>
+ * \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
#include "mlt_types.h"
+/** geometry animation item (deprecated)
+ * \deprecated use mlt_animation_s instead
+ */
+
struct mlt_geometry_item_s
{
/* Will be 1 when this is a key frame */
int f[ 5 ];
};
+/** geometry object (deprecated)
+ * \deprecated use mlt_animation_s instead
+ */
+
struct mlt_geometry_s
{
void *local;