Add internal annotations

paragonie · Apr 17, 2024 · 8e22261 · 8e22261
1 parent 7a3c59d
commit 8e22261
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 0 deletions.
diff --git a/src/Core/AES.php b/src/Core/AES.php
@@ -4,6 +4,8 @@
  * Bitsliced implementation of the AES block cipher.
  *
  * Based on the implementation provided by BearSSL.
+ *
+ * @internal This should only be used by sodium_compat
  */
 class ParagonIE_Sodium_Core_AES extends ParagonIE_Sodium_Core_Util
 {

diff --git a/src/Core/AES/Block.php b/src/Core/AES/Block.php
@@ -4,6 +4,9 @@
     return;
 }
 
+/**
+ * @internal This should only be used by sodium_compat
+ */
 class ParagonIE_Sodium_Core_AES_Block extends SplFixedArray
 {
     /**

diff --git a/src/Core/AES/Expanded.php b/src/Core/AES/Expanded.php
@@ -1,5 +1,8 @@
 <?php
 
+/**
+ * @internal This should only be used by sodium_compat
+ */
 class ParagonIE_Sodium_Core_AES_Expanded extends ParagonIE_Sodium_Core_AES_KeySchedule
 {
     /** @var bool $expanded */

diff --git a/src/Core/AES/KeySchedule.php b/src/Core/AES/KeySchedule.php
@@ -1,5 +1,8 @@
 <?php
 
+/**
+ * @internal This should only be used by sodium_compat
+ */
 class ParagonIE_Sodium_Core_AES_KeySchedule
 {
     /** @var array<int, int> $skey -- has size 120 */
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,6 +4,9 @@ @@
         return;
     }
+    /**
+     * @internal This should only be used by sodium_compat
+     */
     class ParagonIE_Sodium_Core_AES_Block extends SplFixedArray
     {
         /**
@@ Expand Down @@