[clib] Mark clib as experimental

After the removal of the legacy MATLAB toolbox in Cantera#1670, all remaining interfaces that use clib are either experimental (matlab_experimental) or rudimentary/incomplete (Fortran, .NET). The change allows for a faster development cycle to fix accumulated issues and inconsistencies until stable APIs have been implemented.
ischoegl · Aug 9, 2024 · 9ed51b8 · 9ed51b8
1 parent fdefc11
commit 9ed51b8
Show file tree

Hide file tree

Showing 10 changed files with 37 additions and 3 deletions.
diff --git a/include/cantera/clib/clib_defs.h b/include/cantera/clib/clib_defs.h
@@ -1,5 +1,8 @@
 /**
  * @file clib_defs.h
+ *
+ * @warning  This module is an experimental part of the %Cantera API and
+ *      may be changed or removed without notice.
  */
 
 // This file is part of Cantera. See License.txt in the top-level directory or

diff --git a/include/cantera/clib/ct.h b/include/cantera/clib/ct.h
@@ -1,5 +1,8 @@
 /**
  * @file ct.h
+ *
+ * @warning  This module is an experimental part of the %Cantera API and
+ *      may be changed or removed without notice.
  */
 
 // This file is part of Cantera. See License.txt in the top-level directory or

diff --git a/include/cantera/clib/ctfunc.h b/include/cantera/clib/ctfunc.h
@@ -1,5 +1,8 @@
 /**
  * @file ctfunc.h
+ *
+ * @warning  This module is an experimental part of the %Cantera API and
+ *      may be changed or removed without notice.
  */
 
 // This file is part of Cantera. See License.txt in the top-level directory or

diff --git a/include/cantera/clib/ctmatlab.h b/include/cantera/clib/ctmatlab.h
@@ -1,3 +1,13 @@
+/**
+ * @file ctmatlab.h
+ *
+ * @warning  This module is an experimental part of the %Cantera API and
+ *      may be changed or removed without notice.
+ */
+
+// This file is part of Cantera. See License.txt in the top-level directory or
+// at https://cantera.org/license.txt for license and copyright information.
+
 #include "ct.h"
 #include "ctfunc.h"
 #include "ctmultiphase.h"

diff --git a/include/cantera/clib/ctmultiphase.h b/include/cantera/clib/ctmultiphase.h
@@ -1,5 +1,8 @@
 /**
  * @file ctmultiphase.h
+ *
+ * @warning  This module is an experimental part of the %Cantera API and
+ *      may be changed or removed without notice.
  */
 
 // This file is part of Cantera. See License.txt in the top-level directory or

diff --git a/include/cantera/clib/ctonedim.h b/include/cantera/clib/ctonedim.h
@@ -1,5 +1,8 @@
 /**
  * @file ctonedim.h
+ *
+ * @warning  This module is an experimental part of the %Cantera API and
+ *      may be changed or removed without notice.
  */
 
 // This file is part of Cantera. See License.txt in the top-level directory or

diff --git a/include/cantera/clib/ctreactor.h b/include/cantera/clib/ctreactor.h
@@ -1,5 +1,8 @@
 /**
  * @file ctreactor.h
+ *
+ * @warning  This module is an experimental part of the %Cantera API and
+ *      may be changed or removed without notice.
  */
 
 // This file is part of Cantera. See License.txt in the top-level directory or

diff --git a/include/cantera/clib/ctrpath.h b/include/cantera/clib/ctrpath.h
@@ -1,5 +1,8 @@
 /**
  * @file ctrpath.h
+ *
+ * @warning  This module is an experimental part of the %Cantera API and
+ *      may be changed or removed without notice.
  */
 
 // This file is part of Cantera. See License.txt in the top-level directory or

diff --git a/include/cantera/clib/ctsurf.h b/include/cantera/clib/ctsurf.h
@@ -1,5 +1,8 @@
 /**
  * @file ctsurf.h
+ *
+ * @warning  This module is an experimental part of the %Cantera API and
+ *      may be changed or removed without notice.
  */
 
 // This file is part of Cantera. See License.txt in the top-level directory or

diff --git a/src/clib/README.txt b/src/clib/README.txt
@@ -1,4 +1,4 @@
 
-This directory contains code that implements C-callable functions that
-can be used to create and use Cantera objects from languages other
-than C++. It is used by both the .NET and Matlab interface packages.
+This directory contains code that implements C-callable functions that can
+be used to create and use Cantera objects from languages other than C++.
+It is used by both the .NET and experimental MATLAB interface packages.