[arrayfire] 13/26: Adding documentation for array::scalar

[Ghislain Vaillant]

This is an automated email from the git hooks/post-receive script.

ghisvail-guest pushed a commit to branch master
in repository arrayfire.

commit 93786a97637b317adfe68b075447a2b9f3166634
Author: Pavan Yalamanchili <pavan at arrayfire.com>
Date:   Wed Jun 24 09:54:09 2015 -0400

    Adding documentation for array::scalar
---
 include/af/array.h | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/include/af/array.h b/include/af/array.h
index 318f68d..ac754e1 100644
--- a/include/af/array.h
+++ b/include/af/array.h
@@ -651,10 +651,16 @@ namespace af
         void eval() const;
 
         /**
-           @}
+           \brief Get the first element of the array as a scalar
+
+           \note This is recommended for use while debugging. Calling this method constantly reduces performance.
         */
         template<typename T> T scalar() const;
 
+        /**
+           @}
+        */
+
 
         /**
            \defgroup device_func_device array::device<T>

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/arrayfire.git