Test cargo doc on ci

Signed-off-by: Ludvig Liljenberg <[email protected]>

Author: ludfjig

Justfile

@@ -143,7 +143,7 @@ like-ci config=default-target hypervisor="kvm":
     just bench-ci main {{config}} {{ if hypervisor == "mshv" { "mshv2" } else if hypervisor == "mshv3" { "mshv3" } else { "kvm" } }}
 
 # runs all tests
-test target=default-target features="": (test-unit target features) (test-isolated target features) (test-integration "rust" target features) (test-integration "c" target features) (test-seccomp target features)
+test target=default-target features="": (test-unit target features) (test-isolated target features) (test-integration "rust" target features) (test-integration "c" target features) (test-seccomp target features) (test-doc target features)
 
 # runs unit tests
 test-unit target=default-target features="":
@@ -218,6 +218,8 @@ test-rust-tracing target=default-target features="":
     just build-rust-guests {{ target }}
     just move-rust-guests {{ target }}
 
+test-doc target=default-target features="":
+    cargo test --profile={{ if target == "debug" { "dev" } else { target } }} {{ if features =="" {''} else { "--features " + features } }} --doc
 ################
 ### LINTING ####
 ################

src/hyperlight_host/src/func/utils.rs

@@ -18,10 +18,9 @@ limitations under the License.
 /// up to 32 parameters. This is useful to implement traits on functions
 /// for may parameter tuples.
 ///
-/// Usage:
-/// ```rust
-/// use hyperlight_host::func::for_each_tuple;
+/// This is an internal utility macro used within the func module.
 ///
+/// ```ignore
 /// macro_rules! my_macro {
 ///     ([$count:expr] ($($name:ident: $type:ident),*)) => {
 ///         // $count is the arity of the tuple
@@ -30,7 +29,7 @@ limitations under the License.
 ///     };
 /// }
 ///
-/// for_each_tuple!(impl_host_function);
+/// for_each_tuple!(my_macro);
 /// ```
 macro_rules! for_each_tuple {
     (@