Add docstrings for namespaces

NeurodataWithoutBorders · Aug 21, 2024 · 5ffdea6 · 5ffdea6
1 parent a4ed61c
commit 5ffdea6
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 0 deletions.
diff --git a/src/BaseIO.hpp b/src/BaseIO.hpp
@@ -15,6 +15,10 @@ using Status = AQNWB::Types::Status;
 using SizeArray = AQNWB::Types::SizeArray;
 using SizeType = AQNWB::Types::SizeType;
 
+/*!
+ * \namespace AQNWB
+ * \brief The main namespace for AqNWB
+ */
 namespace AQNWB
 {
 

diff --git a/src/hdf5/HDF5IO.hpp b/src/hdf5/HDF5IO.hpp
@@ -17,6 +17,10 @@ class DataType;
 class Exception;
 }  // namespace H5
 
+/*!
+ * \namespace AQNWB::HDF5
+ * \brief Namespace for all components of the HDF5 I/O backend
+ */
 namespace AQNWB::HDF5
 {
 class HDF5RecordingData;  // declare here because gets used in HDF5IO class

diff --git a/src/nwb/NWBFile.hpp b/src/nwb/NWBFile.hpp
@@ -8,6 +8,10 @@
 #include "Types.hpp"
 #include "nwb/base/TimeSeries.hpp"
 
+/*!
+ * \namespace AQNWB::NWB
+ * \brief Namespace for all classes related to the NWB data standard
+ */
 namespace AQNWB::NWB
 {