Add missings docs and #[warn(missing_docs)]

Author: Veykril

Diff for: README.md

@@ -18,8 +18,8 @@ wasm3 = { git = "https://github.com/Veykril/wasm3-rs.git" }
 A simple [example](./examples/call_wasm.rs) that loads a wasm module and executes an exported function to add two `i64`s together.
 
 ```rust
-use wasm3::environment::Environment;
-use wasm3::module::Module;
+use wasm3::Environment;
+use wasm3::Module;
 
 fn main() {
     let env = Environment::new().expect("Unable to create environment");

Diff for: examples/call_wasm.rs

@@ -1,5 +1,5 @@
-use wasm3::environment::Environment;
-use wasm3::module::Module;
+use wasm3::Environment;
+use wasm3::Module;
 
 fn main() {
     let env = Environment::new().expect("Unable to create environment");

Diff for: examples/wasm_link.rs

@@ -1,5 +1,5 @@
-use wasm3::environment::Environment;
-use wasm3::module::Module;
+use wasm3::Environment;
+use wasm3::Module;
 
 const MILLIS: u64 = 500_000;
 

Diff for: examples/wasm_link_closure.rs

@@ -1,5 +1,5 @@
-use wasm3::environment::Environment;
-use wasm3::module::Module;
+use wasm3::Environment;
+use wasm3::Module;
 
 const MILLIS: u64 = 500_000;
 

Diff for: examples/wasm_print.rs

@@ -1,5 +1,5 @@
-use wasm3::environment::Environment;
-use wasm3::module::Module;
+use wasm3::Environment;
+use wasm3::Module;
 
 #[cfg(feature = "wasi")]
 fn main() {

Diff for: src/environment.rs

@@ -14,7 +14,7 @@ impl Drop for DropEnvironment {
     }
 }
 
-/// An environment is required to construct [`Runtime`]s from. It currently serves no real purpose.
+/// An environment is required to construct [`Runtime`]s from. It currently serves no purpose but may in the future.
 #[derive(Debug, Clone)]
 pub struct Environment(Rc<DropEnvironment>);
 

Diff for: src/error.rs

@@ -1,26 +1,41 @@
+//! Error related functionality of wasm3.
 use core::cmp;
 use core::fmt;
 
 use crate::utils::cstr_to_str;
 
+/// Result alias that uses [`Error`].
 pub type Result<T> = core::result::Result<T, Error>;
-
+/// Result alias that uses [`Trap`].
 pub type TrappedResult<T> = core::result::Result<T, Trap>;
+
+/// A wasm trap.
 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
 pub enum Trap {
+    /// Out of bounds memory access
     OutOfBoundsMemoryAccess,
+    /// Division by zero
     DivisionByZero,
+    /// Integer overflow
     IntegerOverflow,
+    /// Integer conversion
     IntegerConversion,
+    /// Indirect call type mismatch
     IndirectCallTypeMismatch,
+    /// Table index out of range
     TableIndexOutOfRange,
+    /// Exit
     Exit,
+    /// Abort
     Abort,
+    /// Unreachable
     Unreachable,
+    /// Stack overflow
     StackOverflow,
 }
 
 impl Trap {
+    #[doc(hidden)]
     pub fn as_ptr(self) -> ffi::M3Result {
         unsafe {
             match self {
@@ -53,10 +68,12 @@ impl fmt::Display for Trap {
     }
 }
 
+/// Error returned by wasm3.
 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
 pub struct Wasm3Error(*const cty::c_char);
 
 impl Wasm3Error {
+    /// Check whether this error is the specified trap.
     pub fn is_trap(self, trap: Trap) -> bool {
         trap.as_ptr() == self.0
     }

Diff for: src/function.rs

@@ -10,6 +10,7 @@ use crate::wasm3_priv;
 use crate::{WasmArgs, WasmType};
 
 // redefine of ffi::RawCall without the Option<T> around it
+/// Type of a raw host function for wasm3.  
 pub type RawCall = unsafe extern "C" fn(
     runtime: ffi::IM3Runtime,
     _sp: ffi::m3stack_t,
@@ -19,7 +20,7 @@ pub type RawCall = unsafe extern "C" fn(
 pub(crate) type NNM3Function = NonNull<ffi::M3Function>;
 
 /// A callable wasm3 function.
-/// This has a generic `call` function for up to 26 parameters.
+/// This has a generic `call` function for up to 26 parameters emulating an overloading behaviour without having to resort to tuples.
 /// These are hidden to not pollute the documentation.
 #[derive(Debug, Copy, Clone)]
 pub struct Function<'rt, ARGS, RET> {

Diff for: src/lib.rs

@@ -1,20 +1,26 @@
 #![cfg_attr(not(feature = "std"), no_std)]
+#![warn(missing_docs)]
 #![warn(clippy::all)]
 #![allow(clippy::new_without_default, clippy::match_bool)]
+//! A rust wrapper for [WASM3](https://github.com/wasm3/wasm3).
 
 extern crate alloc;
 
-pub mod environment;
 pub mod error;
-pub mod function;
-pub mod module;
-pub mod runtime;
 
-mod ty;
-pub use self::ty::{WasmArg, WasmArgs, WasmType};
+mod environment;
+pub use self::environment::Environment;
+mod function;
+pub use self::function::{Function, RawCall};
 mod macros;
 pub use self::macros::*;
+mod module;
+pub use self::module::{Module, ParsedModule};
+mod runtime;
+pub use self::runtime::Runtime;
+mod ty;
+pub use self::ty::{WasmArg, WasmArgs, WasmType};
 mod utils;
-pub(crate) mod wasm3_priv;
-
 pub use ffi as wasm3_sys;
+
+pub(crate) mod wasm3_priv;

Diff for: tests/rust_call_wasm.rs

@@ -1,6 +1,6 @@
-use wasm3::environment::Environment;
-use wasm3::module::Module;
-use wasm3::runtime::Runtime;
+use wasm3::Environment;
+use wasm3::Module;
+use wasm3::Runtime;
 
 fn runtime() -> Runtime {
     Environment::new()