Merge pull request #751 from wasmerio/feature/better-docs

Improved docs with custom logo and favicon

lib/clif-backend/src/lib.rs

@@ -7,6 +7,9 @@
     unused_unsafe,
     unreachable_patterns
 )]
+#![doc(html_favicon_url = "https://wasmer.io/static/icons/favicon.ico")]
+#![doc(html_logo_url = "https://avatars3.githubusercontent.com/u/44205449?s=200&v=4")]
+
 mod cache;
 mod code;
 mod libcalls;

lib/dev-utils/src/lib.rs

@@ -1,2 +1,5 @@
+#![doc(html_favicon_url = "https://wasmer.io/static/icons/favicon.ico")]
+#![doc(html_logo_url = "https://avatars3.githubusercontent.com/u/44205449?s=200&v=4")]
+
 pub mod file_descriptor;
 pub mod stdio;

lib/emscripten/src/lib.rs

@@ -7,6 +7,9 @@
     unused_unsafe,
     unreachable_patterns
 )]
+#![doc(html_favicon_url = "https://wasmer.io/static/icons/favicon.ico")]
+#![doc(html_logo_url = "https://avatars3.githubusercontent.com/u/44205449?s=200&v=4")]
+
 #[macro_use]
 extern crate wasmer_runtime_core;
 

lib/kernel-loader/src/lib.rs

@@ -1,3 +1,6 @@
+#![doc(html_favicon_url = "https://wasmer.io/static/icons/favicon.ico")]
+#![doc(html_logo_url = "https://avatars3.githubusercontent.com/u/44205449?s=200&v=4")]
+
 pub mod service;
 
 use service::{ImportInfo, LoadProfile, RunProfile, ServiceContext, TableEntryRequest};

lib/kernel-net/src/lib.rs

@@ -1,5 +1,7 @@
 #![cfg(all(target_arch = "wasm32", target_os = "wasi"))]
 #![feature(wasi_ext)]
+#![doc(html_favicon_url = "https://wasmer.io/static/icons/favicon.ico")]
+#![doc(html_logo_url = "https://avatars3.githubusercontent.com/u/44205449?s=200&v=4")]
 
 use std::cell::RefCell;
 use std::fs::File;

lib/llvm-backend/src/lib.rs

@@ -8,6 +8,8 @@
 )]
 #![cfg_attr(not(target_os = "windows"), deny(dead_code))]
 #![cfg_attr(nightly, feature(unwind_attributes))]
+#![doc(html_favicon_url = "https://wasmer.io/static/icons/favicon.ico")]
+#![doc(html_logo_url = "https://avatars3.githubusercontent.com/u/44205449?s=200&v=4")]
 
 mod backend;
 mod code;

lib/middleware-common-tests/src/lib.rs

@@ -148,5 +148,4 @@ mod tests {
         // verify it used the correct number of points
         assert_eq!(get_points_used(&instance), 109); // Used points will be slightly more than `limit` because of the way we do gas checking.
     }
-
 }

lib/middleware-common/src/lib.rs

@@ -7,5 +7,8 @@
     unused_unsafe,
     unreachable_patterns
 )]
+#![doc(html_favicon_url = "https://wasmer.io/static/icons/favicon.ico")]
+#![doc(html_logo_url = "https://avatars3.githubusercontent.com/u/44205449?s=200&v=4")]
+
 pub mod call_trace;
 pub mod metering;

lib/runtime-abi/src/lib.rs

@@ -1,4 +1,8 @@
 #![deny(dead_code, unused_imports, unused_variables, unused_unsafe, unreachable_patterns)]
+
+#![doc(html_favicon_url = "https://wasmer.io/static/icons/favicon.ico")]
+#![doc(html_logo_url = "https://avatars3.githubusercontent.com/u/44205449?s=200&v=4")]
+
 #[cfg(not(target_os = "windows"))]
 #[macro_use]
 extern crate failure;

lib/runtime-c-api/src/lib.rs

@@ -1,3 +1,6 @@
+#![doc(html_favicon_url = "https://wasmer.io/static/icons/favicon.ico")]
+#![doc(html_logo_url = "https://avatars3.githubusercontent.com/u/44205449?s=200&v=4")]
+
 //! # Wasmer Runtime C API
 //!
 //! Wasmer is a standalone JIT WebAssembly runtime, aiming to be fully

lib/runtime-core/build.rs

@@ -38,6 +38,5 @@ fn main() {
             .file("image-loading-macos-x86-64.s")
             .compile("image-loading");
     } else {
-
     }
 }

lib/runtime-core/src/lib.rs

@@ -8,6 +8,8 @@
     unreachable_patterns
 )]
 #![cfg_attr(nightly, feature(unwind_attributes))]
+#![doc(html_favicon_url = "https://wasmer.io/static/icons/favicon.ico")]
+#![doc(html_logo_url = "https://avatars3.githubusercontent.com/u/44205449?s=200&v=4")]
 
 #[cfg(test)]
 #[macro_use]

lib/runtime-core/src/memory/mod.rs

@@ -363,5 +363,4 @@ mod memory_tests {
             "Max number of pages is required for shared memory"
         )
     }
-
 }

lib/runtime-core/src/table/mod.rs

@@ -165,5 +165,4 @@ mod table_tests {
         .unwrap();
         assert_eq!(table.size(), 10);
     }
-
 }

lib/runtime-core/src/types.rs

@@ -590,5 +590,4 @@ mod tests {
             f64::from_native(f64::from_binary((yf64).to_native().to_binary()))
         );
     }
-
 }

lib/runtime/src/cache.rs

@@ -173,5 +173,4 @@ mod tests {
         // verify it works
         assert_eq!(value, 43);
     }
-
 }

lib/runtime/src/lib.rs

@@ -7,6 +7,9 @@
     unused_unsafe,
     unreachable_patterns
 )]
+#![doc(html_favicon_url = "https://wasmer.io/static/icons/favicon.ico")]
+#![doc(html_logo_url = "https://avatars3.githubusercontent.com/u/44205449?s=200&v=4")]
+
 //! Wasmer-runtime is a library that makes embedding WebAssembly
 //! in your application easy, efficient, and safe.
 //!

lib/singlepass-backend/src/codegen_x64.rs

@@ -1318,7 +1318,8 @@ impl X64FunctionCode {
                             }
                             m.state
                                 .stack_values
-                                .push(MachineValue::CopyStackBPRelative(offset)); // TODO: Read value at this offset
+                                .push(MachineValue::CopyStackBPRelative(offset));
+                            // TODO: Read value at this offset
                         }
                         _ => {
                             m.state.stack_values.push(MachineValue::Undefined);

lib/singlepass-backend/src/lib.rs

@@ -8,6 +8,8 @@
     unreachable_patterns
 )]
 #![feature(proc_macro_hygiene)]
+#![doc(html_favicon_url = "https://wasmer.io/static/icons/favicon.ico")]
+#![doc(html_logo_url = "https://avatars3.githubusercontent.com/u/44205449?s=200&v=4")]
 
 #[cfg(not(any(
     all(target_os = "macos", target_arch = "x86_64"),

lib/singlepass-backend/src/machine.rs

@@ -502,5 +502,4 @@ mod test {
 
         machine.release_locations_keep_state(&mut assembler, &locs);
     }
-
 }

lib/spectests/tests/spectest.rs

@@ -1265,5 +1265,4 @@ mod tests {
             self.to_bits() == 0x7FF8_0000_0000_0000 || self.to_bits() == 0xFFF8_0000_0000_0000
         }
     }
-
 }

lib/wasi/src/lib.rs

@@ -7,6 +7,9 @@
     unused_unsafe,
     unreachable_patterns
 )]
+#![doc(html_favicon_url = "https://wasmer.io/static/icons/favicon.ico")]
+#![doc(html_logo_url = "https://avatars3.githubusercontent.com/u/44205449?s=200&v=4")]
+
 #[cfg(target = "windows")]
 extern crate winapi;
 

lib/win-exception-handler/src/lib.rs

@@ -7,6 +7,9 @@
     unused_unsafe,
     unreachable_patterns
 )]
+#![doc(html_favicon_url = "https://wasmer.io/static/icons/favicon.ico")]
+#![doc(html_logo_url = "https://avatars3.githubusercontent.com/u/44205449?s=200&v=4")]
+
 #[cfg(windows)]
 mod exception_handling;
 

src/lib.rs

@@ -7,6 +7,9 @@
     unused_unsafe,
     unreachable_patterns
 )]
+#![doc(html_favicon_url = "https://wasmer.io/static/icons/favicon.ico")]
+#![doc(html_logo_url = "https://avatars3.githubusercontent.com/u/44205449?s=200&v=4")]
+
 #[macro_use]
 extern crate wasmer_runtime_core;
 // extern crate wasmer_emscripten;