[arrayfire] 365/408: Documentation for CUDA backend specific API

[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 52f45e98aa1005a98977dcccbe5c7c6af4538434
Author: pradeep <pradeep at arrayfire.com>
Date:   Thu Aug 27 15:09:06 2015 -0400

    Documentation for CUDA backend specific API
---
 include/af/cuda.h | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)

diff --git a/include/af/cuda.h b/include/af/cuda.h
index b3cf921..da2b828 100644
--- a/include/af/cuda.h
+++ b/include/af/cuda.h
@@ -17,10 +17,24 @@ extern "C" {
 #endif
 
 #if AF_API_VERSION >= 31
+/**
+   Get the stream for the CUDA device with \ref id in ArrayFire context
+
+   \param[out] CUDA Stream of device with \ref id in ArrayFire context
+   \param[in] ArrayFire device id
+   \returns \ref af_err error code
+ */
 AFAPI af_err afcu_get_stream(cudaStream_t* stream, int id);
 #endif
 
 #if AF_API_VERSION >= 31
+/**
+   Get the native device id of the CUDA device with \ref id in ArrayFire context
+
+   \param[out] native device id of the CUDA device with \ref id in ArrayFire context
+   \param[in] ArrayFire device id
+   \returns \ref af_err error code
+ */
 AFAPI af_err afcu_get_native_id(int* nativeid, int id);
 #endif
 
@@ -34,6 +48,14 @@ namespace afcu
 {
 
 #if AF_API_VERSION >= 31
+/**
+   Get the stream for the CUDA device with \ref id in ArrayFire context
+
+   \param[in] ArrayFire device id
+   \returns cuda stream used by CUDA device
+
+   \ingroup cuda_mat
+ */
 static inline cudaStream_t getStream(int id)
 {
     cudaStream_t retVal;
@@ -45,6 +67,14 @@ static inline cudaStream_t getStream(int id)
 #endif
 
 #if AF_API_VERSION >= 31
+/**
+   Get the native device id of the CUDA device with \ref id in ArrayFire context
+
+   \param[in] ArrayFire device id
+   \returns cuda native id of device
+
+   \ingroup cuda_mat
+ */
 static inline int getNativeId(int id)
 {
     int retVal;

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