Refs #150 -- document kernel_module! and KernelModule

Author: alex

src/lib.rs

@@ -19,6 +19,25 @@ pub mod user_ptr;
 pub use crate::error::{Error, KernelResult};
 pub use crate::types::{CStr, Mode};
 
+/// Declares the entrypoint for a kernel module. The first argument should be a type which
+/// implements the [`KernelModule`] trait. Also accepts various forms of kernel metadata.
+///
+/// Example:
+/// ```rust,no_run
+/// use linux_kernel_module;
+/// struct MyKernelModule;
+/// impl linux_kernel_module::KernelModule for MyKernelModule {
+///     fn init() -> linux_kernel_module::KernelResult<Self> {
+///         Ok(MyKernelModule)
+///     }
+/// }
+///
+/// linux_kernel_module::kernel_module!(
+///     MyKernelModule,
+///     author: "Fish in a Barrel Contributors",
+///     description: "My very own kernel module!",
+///     license: "GPL"
+/// );
 #[macro_export]
 macro_rules! kernel_module {
     ($module:ty, $($name:ident : $value:expr),*) => {
@@ -61,6 +80,12 @@ macro_rules! kernel_module {
     };
 }
 
+/// KernelModule is the top level entrypoint to implementing a kernel module. Your kernel module
+/// should implement the `init` method on it, which maps to the `module_init` macro in Linux C API.
+/// You can use this method to do whatever setup or registration your module should do. For any
+/// teardown or cleanup operations, your type may implement [`Drop`].
+///
+/// [`Drop`]: https://doc.rust-lang.org/stable/core/ops/trait.Drop.html
 pub trait KernelModule: Sized + Sync {
     fn init() -> KernelResult<Self>;
 }