[arrayfire] 369/408: Added missing docs for complex and opencl backend specific fns

[Ghislain Vaillant]

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 164b39e2b4879869da7dae996b0ee967c42983f1
Author: pradeep <pradeep at arrayfire.com>
Date:   Thu Aug 27 16:25:55 2015 -0400

    Added missing docs for complex and opencl backend specific fns
---
 include/af/arith.h  |  3 +++
 include/af/opencl.h | 31 +++++++++++++++++++++++++++++++
 2 files changed, 34 insertions(+)

diff --git a/include/af/arith.h b/include/af/arith.h
index d258e83..4d3508d 100644
--- a/include/af/arith.h
+++ b/include/af/arith.h
@@ -243,12 +243,15 @@ namespace af
     /// \param[in] lhs is real value(s)
     /// \param[in] rhs is imaginary value(s)
     /// \return complex array from inputs
+    /// \ingroup arith_func_cplx
     AFAPI array complex(const array &lhs, const array &rhs);
 
     /// \copydoc complex(const array&, const array&)
+    /// \ingroup arith_func_cplx
     AFAPI array complex(const array &lhs, const double rhs);
 
     /// \copydoc complex(const array&, const array&)
+    /// \ingroup arith_func_cplx
     AFAPI array complex(const double lhs, const array &rhs);
 
     /// C++ Interface for creating complex array from real array
diff --git a/include/af/opencl.h b/include/af/opencl.h
index 467c4b9..c9f245e 100644
--- a/include/af/opencl.h
+++ b/include/af/opencl.h
@@ -19,12 +19,43 @@
 extern "C" {
 #endif
 
+    /**
+        \ingroup opencl_mat
+        @{
+    */
+    /**
+      Get a handle to ArrayFire's OpenCL context
+
+      \param[out] ctx the current context being used by ArrayFire
+      \param[in] retain if true calls clRetainContext prior to returning the context
+      \returns \ref af_err error code
+
+      \note Set \p retain to true if this value will be passed to a cl::Context constructor
+    */
     AFAPI af_err afcl_get_context(cl_context *ctx, const bool retain);
 
+    /**
+      Get a handle to ArrayFire's OpenCL command queue
+
+      \param[out] queue the current command queue being used by ArrayFire
+      \param[in] retain if true calls clRetainCommandQueue prior to returning the context
+      \returns \ref af_err error code
+
+      \note Set \p retain to true if this value will be passed to a cl::CommandQueue constructor
+    */
     AFAPI af_err afcl_get_queue(cl_command_queue *queue, const bool retain);
 
+    /**
+       Get the device ID for ArrayFire's current active device
+
+       \param[out] id the cl_device_id of the current device
+       \returns \ref af_err error code
+    */
     AFAPI af_err afcl_get_device_id(cl_device_id *id);
 
+    /**
+      @}
+    */
 #ifdef __cplusplus
 }
 #endif

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