docs

Author: devsnek

Cargo.toml

@@ -1,8 +1,10 @@
 [package]
 name = "msfs"
-version = "0.1.0"
+version = "0.0.0-pre.1"
 authors = ["snek"]
 edition = "2018"
+description = "Rust bindings for the MSFS SDK"
+license-file = "LICENSE"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 

LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2020 msfs-rs Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to
+deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+IN THE SOFTWARE.
+

src/lib.rs

@@ -4,6 +4,7 @@ pub mod sys;
 
 // Prevent compilation of non wasm32-wasi targets
 #[cfg(not(target_os = "wasi"))]
+#[doc(hidden)]
 fn invalid() {
     let _: [(); 0] = [0]; // This library only supports wasm32-wasi
 }

src/msfs.rs

@@ -1,8 +1,19 @@
 use crate::sys;
 
+/// MSFS Context. Hashable.
+#[derive(PartialEq, Hash)]
 pub struct FsContext(sys::FsContext);
 
+impl From<sys::FsContext> for FsContext {
+    fn from(ctx: sys::FsContext) -> FsContext {
+        FsContext(ctx)
+    }
+}
+
+/// `PanelServiceID` is used in `GaugeCallback`s and is generated from
+/// `sys::PANEL_SERVICE_*` constants.
 #[repr(u32)]
+#[derive(PartialEq, Clone, Copy)]
 pub enum PanelServiceID {
     PreQuery = sys::PANEL_SERVICE_PRE_QUERY,
     PostQuery = sys::PANEL_SERVICE_POST_QUERY,
@@ -24,15 +35,18 @@ pub enum PanelServiceID {
     PanelClose = sys::PANEL_SERVICE_PANEL_CLOSE,
 }
 
-impl From<sys::FsContext> for FsContext {
-    fn from(ctx: sys::FsContext) -> FsContext {
-        FsContext(ctx)
-    }
-}
-
-pub type GuageCallbackResult = Result<(), ()>;
+/// MSFS Gauges are managed using this lifecycle callback.
 pub type GaugeCallback = fn(&FsContext, PanelServiceID) -> GuageCallbackResult;
+pub type GuageCallbackResult = Result<(), ()>;
 
+/// `gauge!` is used to generate the exported function which is exposed to
+/// MSFS when it loads the WASM binary. Use it like so:
+/// ```rs
+/// fn my_gauge(ctx: &FsContext, servce_id: PanelServiceID) -> GaugeResult {
+///     Ok(())
+/// }
+/// gauge!(my_gauge);
+/// ```
 // FIXME: this should be a proc macro like:
 // ```rs
 // #[msfs::gauge]