Add documentation to Android glue code

.github/workflows/ci.yml

@@ -9,7 +9,7 @@ permissions:
   contents: read
 
 env:
-  RUSTFLAGS: -D warnings -D missing_docs -F unused_must_use
+  RUSTFLAGS: -D warnings -F unused_must_use
 
 jobs:
   clippy:

src/android.rs

@@ -7,9 +7,19 @@ use once_cell::sync::OnceCell;
 
 static GLOBAL: OnceCell<Global> = OnceCell::new();
 
+/// A layer to access the Android runtime which is hosting the current
+/// application process.
+///
+/// Generally this trait should be implemented in your Rust app component's FFI
+/// initialization layer.
 pub trait Runtime: Send + Sync {
+    /// Returns a handle to the current process' JVM.
     fn java_vm(&self) -> &JavaVM;
+    /// Returns a reference to the current app's [Context].
+    ///
+    /// [Context]: <https://developer.android.com/reference/android/content/Context>
     fn context(&self) -> &GlobalRef;
+    /// Returns a reference to the class returned by the current JVM's `getClassLoader` call.
     fn class_loader(&self) -> &GlobalRef;
 }
 

src/lib.rs

@@ -1,5 +1,6 @@
 #![cfg_attr(docsrs, feature(doc_auto_cfg))]
 #![doc = include_str!("../README.md")]
+#![warn(missing_docs)]
 
 use rustls::ClientConfig;
 use std::sync::Arc;

src/tests/ffi.rs

@@ -1,5 +1,6 @@
 //! Thin wrappers ontop the existing test suites that allow them to be ran
 //! in the context of a platform-native environment as required by the verifier implementation.
+#![allow(missing_docs)]
 
 #[cfg(target_os = "android")]
 pub use android::*;