Finite state machines in rust; bendns fork to add types.
re-export the documentation of state_machine macro
Yevhenii Babichenko 2021-02-24
parent 16670e6 · commit 5c9aa45
-rw-r--r--rust_fsm_dsl/src/lib.rs2
-rw-r--r--src/lib.rs3
2 files changed, 3 insertions, 2 deletions
diff --git a/rust_fsm_dsl/src/lib.rs b/rust_fsm_dsl/src/lib.rs
index 04e9594..e6b9e10 100644
--- a/rust_fsm_dsl/src/lib.rs
+++ b/rust_fsm_dsl/src/lib.rs
@@ -21,6 +21,8 @@ struct Transition<'a> {
}
#[proc_macro]
+/// Produce a state machine definition from the provided `rust-fmt` DSL
+/// description.
pub fn state_machine(tokens: TokenStream) -> TokenStream {
let input = parse_macro_input!(tokens as parser::StateMachineDef);
diff --git a/src/lib.rs b/src/lib.rs
index e8b78bb..17b4e6b 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -126,8 +126,7 @@ use core::fmt;
#[cfg(feature = "std")]
use std::error::Error;
-#[doc(hidden)]
-pub use rust_fsm_dsl::*;
+pub use rust_fsm_dsl::state_machine;
/// This trait is designed to describe any possible deterministic finite state
/// machine/transducer. This is just a formal definition that may be