From fe454d31df419c82652702a978be6d955a5dc254 Mon Sep 17 00:00:00 2001
From: raster <raster@7cbeb6ba-43b4-40fd-8cce-4c39aea84d33>
Date: Wed, 20 Apr 2011 08:24:56 +0000
Subject: [PATCH] lets properly document filter calls and return sane values

git-svn-id: svn+ssh://svn.enlightenment.org/var/svn/e/trunk/evas@58751 7cbeb6ba-43b4-40fd-8cce-4c39aea84d33
---
 src/lib/Evas.h               | 40 ++++++++++++++++++++++++++++++++++++++--
 src/lib/canvas/evas_filter.c |  4 ++--
 2 files changed, 40 insertions(+), 4 deletions(-)

diff --git a/src/lib/Evas.h b/src/lib/Evas.h
index 92800a0..3315eee 100644
--- a/src/lib/Evas.h
+++ b/src/lib/Evas.h
@@ -7936,7 +7936,7 @@ EAPI Eina_List                          *evas_object_table_children_get    (cons
  * set.
  *
  * @param o Object to get filter mode of.
- * @return Filter mode (default EVAS_FILTER_MODE_OBJECT）
+ * @return Filter mode (default EVAS_FILTER_MODE_OBJECT)
  */
    EAPI Evas_Filter_Mode                     evas_object_filter_mode_get      (Evas_Object *o);
    
@@ -7965,6 +7965,7 @@ EAPI Eina_List                          *evas_object_table_children_get    (cons
  * @return The filter if set, or EVAS_FILTER_NONE.
  */
    EAPI Evas_Filter                          evas_object_filter_get           (Evas_Object *o);
+   
 /**
  * Set an integer parameter of a filter.
  *
@@ -7999,14 +8000,38 @@ EAPI Eina_List                          *evas_object_table_children_get    (cons
  */
    EAPI int                                  evas_object_filter_param_int_get (Evas_Object *o, const char *param);
    
+/**
+ * Set a string parameter on a filter
+ * 
+ * Currently unimplemented as no filters use this yet
+ */
    EAPI Eina_Bool                            evas_object_filter_param_str_set (Evas_Object *o, const char *param, const char *val);
+   
+/**
+ * Get a string parameter from a filter
+ * 
+ * Currently unimplemented as no filters use this yet
+ */
    EAPI const char                          *evas_object_filter_param_str_get (Evas_Object *o, const char *param);
+   
+/**
+ * Set an object parameter on a filter
+ * 
+ * Currently unimplemented as no filters use this yet
+ */
    EAPI Eina_Bool                            evas_object_filter_param_obj_set (Evas_Object *o, const char *param, Evas_Object *val);
+
+/**
+ * get an object parameter from a filter
+ * 
+ * Currently unimplemented as no filters use this yet
+ */
    EAPI Evas_Object                         *evas_object_filter_param_obj_get (Evas_Object *o, const char *param);
+   
 /**
  * Set a float parameter of a filter.
  *
- * This is the same as evas_object_filter_param_get_int(), but for floating
+ * This is the same as evas_object_filter_param_int_set(), but for floating
  * point values.
  *
  * @param o Object to set value on.
@@ -8014,6 +8039,17 @@ EAPI Eina_List                          *evas_object_table_children_get    (cons
  * @param EINA_TRUE if at least one parameter was set, EINA_FALSE otherwise.
  */
    EAPI Eina_Bool                            evas_object_filter_param_float_set(Evas_Object *o, const char *param, double val);
+   
+/**
+ * Get a float parameter of a filter.
+ *
+ * This is the same as evas_object_filter_param_int_get(), but for floating
+ * point values.
+ *
+ * @param o Object to set value on.
+ * @param param Name of the parameter to set.
+ * @return The value, or -1 on error.
+ */
    EAPI double                               evas_object_filter_param_float_get(Evas_Object *o, const char *param);
          
 /**
diff --git a/src/lib/canvas/evas_filter.c b/src/lib/canvas/evas_filter.c
index cd084cf..d39e581 100644
--- a/src/lib/canvas/evas_filter.c
+++ b/src/lib/canvas/evas_filter.c
@@ -269,7 +269,7 @@ evas_object_filter_param_int_get(Evas_Object *o, const char *param)
    int i;
 
    MAGIC_CHECK(o, Evas_Object, MAGIC_OBJ);
-   return EINA_FALSE;
+   return -1;
    MAGIC_CHECK_END();
 
    if ((!o->filter) || (!o->filter->data)) return -1;
@@ -362,7 +362,7 @@ evas_object_filter_param_float_get(Evas_Object *o, const char *param)
    int i;
 
    MAGIC_CHECK(o, Evas_Object, MAGIC_OBJ);
-   return EINA_FALSE;
+   return -1;
    MAGIC_CHECK_END();
 
    if ((!o->filter) || (!o->filter->data)) return -1;
-- 
2.7.4