Update header file documentation

open-quantum-safe · Jan 12, 2024 · b2a5a2d · b2a5a2d
1 parent 12528d1
commit b2a5a2d
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/src/common/aes/aes.h b/src/common/aes/aes.h
@@ -1,6 +1,9 @@
 /**
  * \file aes.h
- * \brief Header defining the API for OQS AES
+ * \brief Header defining the API for OQS AES; not part of the public OQS API
+ *
+ * <b>Note this is not part of the OQS public API: implementations within liboqs can use these
+ * functions, but external consumers of liboqs should not use these functions.</b>
  *
  * SPDX-License-Identifier: MIT
  */

diff --git a/src/oqs.h b/src/oqs.h
@@ -1,6 +1,6 @@
 /**
  * \file oqs.h
- * \brief Overall header file for liboqs.
+ * \brief Overall header file for the liboqs public API.
  *
  * C programs using liboqs can include just this one file, and it will include all
  * other necessary headers from liboqs.