add doc for pub func

Signed-off-by: guoweikang <[email protected]>
arceos-org · Oct 16, 2024 · f0e1041 · f0e1041
1 parent 6f38819
commit f0e1041
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/lib.rs b/src/lib.rs
@@ -116,6 +116,7 @@ macro_rules! def_node {
         }
 
         impl $struct_name {
+            #[doc = "Create a node"]
             pub const fn new(inner: $type) -> Self {
                 Self {
                     inner,
@@ -124,6 +125,7 @@ macro_rules! def_node {
             }
 
             #[inline]
+            #[doc = "Get inner"]
             pub fn inner(&self) -> &$type {
                 &self.inner
             }
@@ -160,6 +162,7 @@ macro_rules! def_generic_node {
         }
 
         impl<T> $struct_name<T> {
+            #[doc = "Create a node"]
             pub const fn new(inner: T) -> Self {
                 Self {
                     inner,
@@ -168,6 +171,7 @@ macro_rules! def_generic_node {
             }
 
             #[inline]
+            #[doc = "Get inner"]
             pub fn inner(&self) -> &T {
                 &self.inner
             }