From: Timo Heister <timo.heister@gmail.com>
Date: Wed, 7 Mar 2018 21:10:43 +0000 (-0500)
Subject: cuda doxygen
X-Git-Tag: v9.0.0-rc1~357^2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F6006%2Fhead;p=dealii.git

cuda doxygen
---

diff --git a/doc/doxygen/headers/cuda.h b/doc/doxygen/headers/cuda.h
new file mode 100644
index 0000000000..01ed4dcd86
--- /dev/null
+++ b/doc/doxygen/headers/cuda.h
@@ -0,0 +1,22 @@
+// ---------------------------------------------------------------------
+//
+// Copyright (C) 2018 by the deal.II authors
+//
+// This file is part of the deal.II library.
+//
+// The deal.II library is free software; you can use it, redistribute
+// it, and/or modify it under the terms of the GNU Lesser General
+// Public License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+// The full text of the license can be found in the file LICENSE at
+// the top level of the deal.II distribution.
+//
+// ---------------------------------------------------------------------
+
+
+/**
+ * @defgroup CUDAWrappers CUDA Wrappers
+ *
+ * The classes in this module are concerned with the description of features
+ * to be run on GPUs using CUDA.
+ */
diff --git a/doc/doxygen/options.dox.in b/doc/doxygen/options.dox.in
index c1770131a2..1486dadb1b 100644
--- a/doc/doxygen/options.dox.in
+++ b/doc/doxygen/options.dox.in
@@ -199,6 +199,7 @@ PREDEFINED             = DOXYGEN=1 \
                          DEAL_II_ENABLE_EXTRA_DIAGNOSTICS= \
                          DEAL_II_DISABLE_EXTRA_DIAGNOSTICS= \
                          DEAL_II_DEPRECATED= \
+                         DEAL_II_CUDA_HOST_DEV= \
                          DEAL_II_P4EST_VERSION_GTE=1 \
                          DEAL_II_TRILINOS_VERSION_GTE=1
 
diff --git a/include/deal.II/lac/cuda_vector.h b/include/deal.II/lac/cuda_vector.h
index 488138ccfb..6b897510ca 100644
--- a/include/deal.II/lac/cuda_vector.h
+++ b/include/deal.II/lac/cuda_vector.h
@@ -31,6 +31,9 @@ template <typename Number> class ReadWriteVector;
 
 namespace LinearAlgebra
 {
+  /**
+   * A Namespace for the CUDA vectors.
+   */
   namespace CUDAWrappers
   {
     /**
diff --git a/include/deal.II/matrix_free/cuda_fe_evaluation.h b/include/deal.II/matrix_free/cuda_fe_evaluation.h
index 5cfbd162ac..3ae1018202 100644
--- a/include/deal.II/matrix_free/cuda_fe_evaluation.h
+++ b/include/deal.II/matrix_free/cuda_fe_evaluation.h
@@ -25,6 +25,9 @@
 
 DEAL_II_NAMESPACE_OPEN
 
+/**
+ * Namespace for the CUDA wrappers
+ */
 namespace CUDAWrappers
 {
   namespace internal