Add some basic U256 and I256 doc comments

stellar · Jun 23, 2023 · b38b716 · b38b716
1 parent c20b456
commit b38b716
Showing 1 changed file with 15 additions and 3 deletions.
diff --git a/soroban-sdk/src/num.rs b/soroban-sdk/src/num.rs
@@ -10,7 +10,8 @@ use crate::env::internal::xdr::ScVal;
 use crate::{env::MaybeEnv, unwrap::UnwrapInfallible};
 
 macro_rules! impl_num_wrapping_val_type {
-    ($wrapper:ident, $val:ty, $small:ty) => {
+    (#[doc = $doc:expr] $wrapper:ident, $val:ty, $small:ty) => {
+        #[doc = $doc]
         #[derive(Clone)]
         pub struct $wrapper {
             env: MaybeEnv,
@@ -159,5 +160,16 @@ macro_rules! impl_num_wrapping_val_type {
     };
 }
 
-impl_num_wrapping_val_type!(U256, U256Val, U256Small);
-impl_num_wrapping_val_type!(I256, I256Val, I256Small);
+impl_num_wrapping_val_type!(
+    /// U256 holds a 256-bit unsigned integer.
+    U256,
+    U256Val,
+    U256Small
+);
+
+impl_num_wrapping_val_type!(
+    /// I256 holds a 256-bit signed integer.
+    I256,
+    I256Val,
+    I256Small
+);