docs(type-gen): add docs for new method

andrewsonin · Apr 27, 2024 · 1b9e45d · 1b9e45d
1 parent 7e7935b
commit 1b9e45d
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 0 deletions.
diff --git a/src/type_gen/key_wrapper.rs b/src/type_gen/key_wrapper.rs
@@ -110,6 +110,7 @@ macro_rules! key_wrapper_inner {
         #[cfg(not(loom))]
         impl $new_type
         {
+            #[doc = ::std::concat!("Creates a new instance of [`", ::std::stringify!($new_type), "`].")]
             #[inline]
             $vis fn new(value: $orig_type) -> Self {
                 use $crate::traits::BlazeMapIdStatic;

diff --git a/src/type_gen/key_wrapper_bounded.rs b/src/type_gen/key_wrapper_bounded.rs
@@ -115,6 +115,7 @@ macro_rules! key_wrapper_bounded_inner {
         #[cfg(not(loom))]
         impl $new_type
         {
+            #[doc = ::std::concat!("Creates a new instance of [`", ::std::stringify!($new_type), "`].")]
             #[inline]
             $vis fn new(value: $orig_type) -> Self {
                 use $crate::traits::BlazeMapIdStatic;

diff --git a/src/type_gen/plain_id.rs b/src/type_gen/plain_id.rs
@@ -71,13 +71,15 @@ macro_rules! plain_id_inner {
 
         impl $new_type
         {
+            #[doc = ::std::concat!("Creates a new instance of [`", ::std::stringify!($new_type), "`].")]
             #[inline]
             #[cfg(not(loom))]
             $vis fn new() -> Self {
                 let next_id = <Self as $crate::prelude::BlazeMapIdStatic>::static_container().next_id();
                 Self(unsafe { $crate::utils::OffsetProvider::<usize>::new(next_id) })
             }
 
+            #[doc = ::std::concat!("Creates a new instance of [`", ::std::stringify!($new_type), "`].")]
             #[inline]
             #[cfg(loom)]
             $vis fn new(type_info_container: &<Self as $crate::prelude::BlazeMapId>::TypeInfoContainer) -> Self {