add doc by concat

Signed-off-by: usamoi <[email protected]>
pgcentralfoundation · Feb 12, 2024 · 489c4ca · 489c4ca
1 parent f8b1c1d
commit 489c4ca
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/pgrx/src/pg_catalog.rs b/pgrx/src/pg_catalog.rs
@@ -47,6 +47,7 @@ macro_rules! define_character {
         $table:ident, ($column:ident, character { $(($variant:ident, $value:literal))* } $($x:tt)*)
     } => {
         paste::paste! {
+            #[doc = concat!("The enum for column ", stringify!($column), " in catalog ", stringify!($table), ".")]
             #[non_exhaustive]
             #[repr(u8)]
             #[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
@@ -201,6 +202,7 @@ macro_rules! define_catalog_or_cache {
                 }
             }
 
+            #[doc = concat!("The search result for catalog ", stringify!($table), ".")]
             pub struct [<$table:camel Search>] {
                 inner: Option<std::ptr::NonNull<pgrx::pg_sys::HeapTupleData>>,
                 cache_id: i32,
@@ -232,6 +234,7 @@ macro_rules! define_catalog_or_cache {
                 }
             }
 
+            #[doc = concat!("The search results for catalog ", stringify!($table), ".")]
             pub struct [<$table:camel SearchList>] {
                 inner: std::ptr::NonNull<pgrx::pg_sys::CatCList>,
                 cache_id: i32,