DOCS: Updating documentation for replace.

pavanky · pavanky · commit 7f1a3fd7d9bb · 2016-04-21T16:10:15.000-04:00
diff --git a/docs/details/data.dox b/docs/details/data.dox
@@ -338,8 +338,8 @@ array/value is selected.
 
 \brief Replace elements of an array based on an conditional array
 
-If the condition array has an element as true, then the element is
-replaced by the array/value, otherwise no change.
+- Input values are retained when corresponding elements from condition array are true.
+- Input values are replaced when corresponding elements from condition array are false.
 
 \ingroup manip_mat
 \ingroup arrayfire_func
diff --git a/include/af/data.h b/include/af/data.h
@@ -517,9 +517,11 @@ namespace af
 
 #if AF_API_VERSION >= 31
     /**
-       \param[inout]  a is the array whose values are replaced with values from \p b when \p cond is false
-       \param[in]  cond is the conditional array
-       \param[in]  b is the array containing elements which replace elements in \p a when \p cond is false
+       \param[inout]  a is the input array
+       \param[in]  cond is the conditional array.
+       \param[in]  b is the replacement array.
+
+       \note Values of \p a are replaced with corresponding values of \p b, when \p cond is false.
 
        \ingroup data_func_replace
     */
@@ -528,9 +530,11 @@ namespace af
 
 #if AF_API_VERSION >= 31
     /**
-       \param[inout]  a is the array whose values are replaced with values from \p b when \p cond is false
-       \param[in]  cond is the conditional array
-       \param[in]  b is value that replaces elements in \p a when \p cond is false
+       \param[inout]  a is the input array
+       \param[in]  cond is the conditional array.
+       \param[in]  b is the replacement value.
+
+       \note Values of \p a are replaced with corresponding values of \p b, when \p cond is false.
 
        \ingroup data_func_replace
     */
@@ -836,9 +840,11 @@ extern "C" {
 
 #if AF_API_VERSION >= 31
     /**
-       \param[inout] a is the array whose values are replaced by \p b when \p cond is false
-       \param[in]  cond is the conditional array
-       \param[in]  b is the array containing elements that replaces elements of a where \p cond is false
+       \param[inout]  a is the input array
+       \param[in]  cond is the conditional array.
+       \param[in]  b is the replacement array.
+
+       \note Values of \p a are replaced with corresponding values of \p b, when \p cond is false.
 
        \ingroup data_func_replace
     */
@@ -847,9 +853,11 @@ extern "C" {
 
 #if AF_API_VERSION >= 31
     /**
-       \param[inout] a is the array whose values are replaced by \p b when \p cond is false
-       \param[in]  cond is the conditional array
-       \param[in]  b is the scalar that replaces the false parts of \p a
+       \param[inout]  a is the input array
+       \param[in]  cond is the conditional array.
+       \param[in]  b is the replacement array.
+
+       \note Values of \p a are replaced with corresponding values of \p b, when \p cond is false.
 
        \ingroup data_func_replace
     */
