[arrayfire] 370/408: Added missing docs for operator%, array::H and array::T

Ghislain Vaillant ghisvail-guest at moszumanska.debian.org
Mon Sep 21 19:12:33 UTC 2015


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

ghisvail-guest pushed a commit to branch debian/sid
in repository arrayfire.

commit 4f6087230cdec0b1b47d0ac7510012b3f69fb6fd
Author: pradeep <pradeep at arrayfire.com>
Date:   Thu Aug 27 16:43:46 2015 -0400

    Added missing docs for operator%, array::H and array::T
---
 include/af/array.h | 11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)

diff --git a/include/af/array.h b/include/af/array.h
index b652d04..bdc6502 100644
--- a/include/af/array.h
+++ b/include/af/array.h
@@ -802,8 +802,15 @@ namespace af
 
         ~array();
 
-        // Transpose and Conjugate Tranpose
+        /// \brief Get the transposed the array
+        ///
+        /// \returns Transposed matrix
+        /// \ingroup method_mat
         array T() const;
+        /// \brief Get the conjugate-transpose of the current array
+        ///
+        /// \returns conjugate-transpose matrix
+        /// \ingroup method_mat
         array H() const;
 
 #define ASSIGN(OP)                                                                      \
@@ -1093,7 +1100,7 @@ namespace af
     BIN_OP(operator||)
     /// @}
 
-    /// \ingroup numeric_func_mod
+    /// \ingroup arith_func_mod
     /// @{
     /// \brief Performs an modulo operation on two arrays or an array and a value.
     ///

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



More information about the debian-science-commits mailing list