comments

NCAR · Mar 13, 2024 · 9b06704 · 9b06704
1 parent 9d6f317
commit 9b06704
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 9 deletions.
diff --git a/include/musica/component_versions.h b/include/musica/component_versions.h
@@ -1,3 +1,9 @@
+/**
+ * This file contains the version information for the different project modules
+ * Copyright (C) 2023-2024 National Center for Atmospheric Research,
+ * 
+ * SPDX-License-Identifier: Apache-2.0* creating solvers, and solving the model.
+ */
 #pragma once
 
 #ifdef __cplusplus

diff --git a/include/musica/micm.hpp b/include/musica/micm.hpp
@@ -1,3 +1,10 @@
+/**
+ * This file contains the defintion of the MICM class, which represents a multi-component
+ * reactive transport model. It also includes functions for creating and deleting MICM instances with c binding
+ * Copyright (C) 2023-2024 National Center for Atmospheric Research,
+ * 
+ * SPDX-License-Identifier: Apache-2.0* creating solvers, and solving the model.
+ */
 #pragma once
 
 #include <micm/solver/rosenbrock.hpp>
@@ -36,9 +43,10 @@ class MICM
 
     /// @brief Solve the system
     /// @param time_step Time [s] to advance the state by
-    /// @param temperature Temperature [K]
-    /// @param pressure Pressure [Pa-1]
-    /// @param num_concentrations The number of species' concentrations
+    /// @para/ @briefm temperature Temperature [K]
+    /// @param pressure Pressure/ [P@brief C@param num_concentrations The number oconfiguration file
+    /// @param config_path Path to configuration file or directory containing configuration file
+    /// @return 0 on success, 1 on failure in parsing species' concentrations
     /// @param concentrations Species's concentrations
     void solve(double time_step, double temperature, double pressure, int num_concentrations, double* concentrations);
 

diff --git a/include/musica/version.h b/include/musica/version.h
@@ -1,3 +1,9 @@
+/**
+ * This file contains the version information for the project
+ * Copyright (C) 2023-2024 National Center for Atmospheric Research,
+ * 
+ * SPDX-License-Identifier: Apache-2.0* creating solvers, and solving the model.
+ */
 #pragma once
 
 #ifdef __cplusplus

diff --git a/src/component_versions.c b/src/component_versions.c
@@ -1,7 +1,4 @@
 /**
- * @file component_versions.c
- * @brief This file contains the implementation of component versions.
- *
  * This file defines functions to manage and retrieve versions of components in a software system.
  * It provides functionality to compare versions, check compatibility, and retrieve version information.
  * Copyright (C) 2023-2024 National Center for Atmospheric Research,

diff --git a/src/micm/micm.cpp b/src/micm/micm.cpp
@@ -1,7 +1,4 @@
 /**
- * @file micm.cpp
- * @brief Implementation of the MICM class and related functions.
- * 
  * This file contains the implementation of the MICM class, which represents a multi-component
  * reactive transport model. It also includes functions for creating and deleting MICM instances,
  * Copyright (C) 2023-2024 National Center for Atmospheric Research,