#34 Added file docstrings to the general implementations.

jamesavery · Sep 16, 2024 · 1139ca4 · 1139ca4
1 parent b67ee13
commit 1139ca4
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 0 deletions.
diff --git a/src/lib/cpp/cpu/general.cc b/src/lib/cpp/cpu/general.cc
@@ -1,3 +1,12 @@
+/**
+ * @file general.cc
+ * @author Carl-Johannes Johnsen ([email protected])
+ * @brief Generic functions that can be used in a variety of contexts. Mostly parallel implementations of common numpy / scipy functions.
+ * @version 0.1
+ * @date 2024-09-16
+ *
+ * @copyright Copyright (c) 2024
+ */
 #include "general.hh"
 
 // Header only library so far.
diff --git a/src/lib/cpp/cpu_seq/general.cc b/src/lib/cpp/cpu_seq/general.cc
@@ -1,3 +1,12 @@
+/**
+ * @file general.cc
+ * @author Carl-Johannes Johnsen ([email protected])
+ * @brief Generic functions that can be used in a variety of contexts. Mostly parallel implementations of common numpy / scipy functions.
+ * @version 0.1
+ * @date 2024-09-16
+ *
+ * @copyright Copyright (c) 2024
+ */
 #include "general.hh"
 
 // Header only library so far.
diff --git a/src/lib/cpp/gpu/general.cc b/src/lib/cpp/gpu/general.cc
@@ -1,3 +1,12 @@
+/**
+ * @file general.cc
+ * @author Carl-Johannes Johnsen ([email protected])
+ * @brief Generic functions that can be used in a variety of contexts. Mostly parallel implementations of common numpy / scipy functions.
+ * @version 0.1
+ * @date 2024-09-16
+ *
+ * @copyright Copyright (c) 2024
+ */
 #include "general.hh"
 
 // Header only library so far.