document every item in native-core

packages/native-core/src/lib.rs

@@ -1,10 +1,10 @@
+#![doc = include_str!("../README.md")]
+#![warn(missing_docs)]
+
 use std::any::Any;
 use std::hash::BuildHasherDefault;
 
-pub use node_ref::NodeMask;
-pub use passes::AnyMapLike;
-pub use passes::{run_pass, Dependancy, PassDirection, RunPassView, State, TypeErasedPass};
-pub use real_dom::{NodeMut, NodeRef, RealDom};
+use node_ref::NodeMask;
 use rustc_hash::FxHasher;
 
 #[cfg(feature = "dioxus")]
@@ -19,22 +19,29 @@ pub mod tree;
 pub mod utils;
 pub use shipyard::EntityId as NodeId;
 
-// exported for the macro
 pub mod exports {
+    //! Important dependencies that are used by the rest of the library
+    //! Feel free to just add the dependencies in your own Crates.toml
+    // exported for the macro
     #[doc(hidden)]
     pub use rustc_hash::FxHashSet;
     pub use shipyard;
 }
 
+/// A prelude of commonly used items
 pub mod prelude {
     pub use crate::node::{ElementNode, FromAnyValue, NodeType, OwnedAttributeView, TextNode};
     pub use crate::node_ref::{AttributeMaskBuilder, NodeMaskBuilder, NodeView};
-    pub use crate::passes::{AnyState, Dependancy, DependancyView, State};
+    pub use crate::passes::{run_pass, PassDirection, RunPassView, TypeErasedState};
+    pub use crate::passes::{Dependancy, DependancyView, State};
     pub use crate::real_dom::{NodeImmutable, NodeMut, NodeRef, RealDom};
     pub use crate::NodeId;
     pub use crate::SendAnyMap;
 }
 
+/// A map that can be sent between threads
 pub type FxDashMap<K, V> = dashmap::DashMap<K, V, BuildHasherDefault<FxHasher>>;
+/// A set that can be sent between threads
 pub type FxDashSet<K> = dashmap::DashSet<K, BuildHasherDefault<FxHasher>>;
+/// A map of types that can be sent between threads
 pub type SendAnyMap = anymap::Map<dyn Any + Send + Sync + 'static>;