From: Dan Dennedy <dan@dennedy.org>
Date: Sun, 2 Jun 2013 19:44:19 +0000 (-0700)
Subject: Indicate mlt_geometry is deprecated in API docs.
X-Git-Url: https://git.sesse.net/?a=commitdiff_plain;h=339b6ccd272efe41bf599abd4397f8a24191a91d;p=mlt

Indicate mlt_geometry is deprecated in API docs.
---

diff --git a/src/framework/mlt.h b/src/framework/mlt.h
index b8adca9a..9d93064f 100644
--- a/src/framework/mlt.h
+++ b/src/framework/mlt.h
@@ -24,6 +24,15 @@
 #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"
 {
diff --git a/src/framework/mlt_animation.c b/src/framework/mlt_animation.c
index 7468bb58..14b79782 100644
--- a/src/framework/mlt_animation.c
+++ b/src/framework/mlt_animation.c
@@ -1,7 +1,7 @@
 /**
  * \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>
diff --git a/src/framework/mlt_animation.h b/src/framework/mlt_animation.h
index 4dbd60dc..a102596f 100644
--- a/src/framework/mlt_animation.h
+++ b/src/framework/mlt_animation.h
@@ -1,7 +1,7 @@
 /**
  * \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>
diff --git a/src/framework/mlt_geometry.c b/src/framework/mlt_geometry.c
index 301963dd..6b41d330 100644
--- a/src/framework/mlt_geometry.c
+++ b/src/framework/mlt_geometry.c
@@ -1,7 +1,10 @@
-/*
- * 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
@@ -27,6 +30,10 @@
 #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;
@@ -34,6 +41,10 @@ typedef struct geometry_item_s
 }
 *geometry_item;
 
+/** private part of geometry object (deprecated)
+ * \deprecated use mlt_animation_s instead
+ */
+
 typedef struct
 {
 	char *data;
diff --git a/src/framework/mlt_geometry.h b/src/framework/mlt_geometry.h
index e753c67b..fffe2d84 100644
--- a/src/framework/mlt_geometry.h
+++ b/src/framework/mlt_geometry.h
@@ -1,7 +1,10 @@
-/*
- * 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
@@ -23,6 +26,10 @@
 
 #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 */
@@ -37,6 +44,10 @@ struct mlt_geometry_item_s
 	int f[ 5 ];
 };
 
+/** geometry object (deprecated)
+ * \deprecated use mlt_animation_s instead
+ */
+
 struct mlt_geometry_s
 {
 	void *local;