More rust docs

Switch from allow(missing_docs) to deny(missing_docs), which should
gradually help us moving forward.  Also, add a few missing docs, such as
for sched and aio.

3 files changed, 31 insertions, 1 deletions

diff --git a/src/sys/aio.rs b/src/sys/aio.rs
index 71a2184d..ae08a1fc 100644
--- a/src/sys/aio.rs
+++ b/src/sys/aio.rs
@@ -60,8 +60,11 @@ libc_enum! {
     #[repr(i32)]
     #[non_exhaustive]
     pub enum LioOpcode {
+        /// No operation
         LIO_NOP,
+        /// Write data as if by a call to [`aio_write`]
         LIO_WRITE,
+        /// Write data as if by a call to [`aio_read`]
         LIO_READ,
     }
 }
@@ -840,6 +843,7 @@ unsafe impl<'a> Sync for LioCb<'a> {}
 
 #[cfg(not(any(target_os = "ios", target_os = "macos")))]
 impl<'a> LioCb<'a> {
+    /// Are no [`AioCb`]s contained?
     pub fn is_empty(&self) -> bool {
         self.aiocbs.is_empty()
     }
diff --git a/src/sys/mod.rs b/src/sys/mod.rs
index cffefdc3..2f356801 100644
--- a/src/sys/mod.rs
+++ b/src/sys/mod.rs
@@ -1,3 +1,4 @@
+//! Mostly platform-specific functionality
 #[cfg(any(target_os = "dragonfly",
           target_os = "freebsd",
           target_os = "ios",
@@ -7,6 +8,7 @@
 pub mod aio;
 
 #[cfg(any(target_os = "android", target_os = "linux"))]
+#[allow(missing_docs)]
 pub mod epoll;
 
 #[cfg(any(target_os = "dragonfly",
@@ -15,9 +17,11 @@ pub mod epoll;
           target_os = "macos",
           target_os = "netbsd",
           target_os = "openbsd"))]
+#[allow(missing_docs)]
 pub mod event;
 
 #[cfg(any(target_os = "android", target_os = "linux"))]
+#[allow(missing_docs)]
 pub mod eventfd;
 
 #[cfg(any(target_os = "android",
@@ -34,14 +38,18 @@ pub mod eventfd;
 pub mod ioctl;
 
 #[cfg(target_os = "linux")]
+#[allow(missing_docs)]
 pub mod memfd;
 
 #[cfg(not(target_os = "redox"))]
+#[allow(missing_docs)]
 pub mod mman;
 
 #[cfg(target_os = "linux")]
+#[allow(missing_docs)]
 pub mod personality;
 
+#[allow(missing_docs)]
 pub mod pthread;
 
 #[cfg(any(target_os = "android",
@@ -51,18 +59,22 @@ pub mod pthread;
           target_os = "macos",
           target_os = "netbsd",
           target_os = "openbsd"))]
+#[allow(missing_docs)]
 pub mod ptrace;
 
 #[cfg(target_os = "linux")]
 pub mod quota;
 
 #[cfg(any(target_os = "linux"))]
+#[allow(missing_docs)]
 pub mod reboot;
 
 #[cfg(not(any(target_os = "redox", target_os = "fuchsia", target_os = "illumos")))]
+#[allow(missing_docs)]
 pub mod resource;
 
 #[cfg(not(target_os = "redox"))]
+#[allow(missing_docs)]
 pub mod select;
 
 #[cfg(any(target_os = "android",
@@ -70,16 +82,21 @@ pub mod select;
           target_os = "ios",
           target_os = "linux",
           target_os = "macos"))]
+#[allow(missing_docs)]
 pub mod sendfile;
 
+#[allow(missing_docs)]
 pub mod signal;
 
 #[cfg(any(target_os = "android", target_os = "linux"))]
+#[allow(missing_docs)]
 pub mod signalfd;
 
 #[cfg(not(target_os = "redox"))]
+#[allow(missing_docs)]
 pub mod socket;
 
+#[allow(missing_docs)]
 pub mod stat;
 
 #[cfg(any(target_os = "android",
@@ -90,25 +107,34 @@ pub mod stat;
           target_os = "macos",
           target_os = "openbsd"
 ))]
+#[allow(missing_docs)]
 pub mod statfs;
 
 pub mod statvfs;
 
 #[cfg(any(target_os = "android", target_os = "linux"))]
+#[allow(missing_docs)]
 pub mod sysinfo;
 
+#[allow(missing_docs)]
 pub mod termios;
 
+#[allow(missing_docs)]
 pub mod time;
 
+#[allow(missing_docs)]
 pub mod uio;
 
+#[allow(missing_docs)]
 pub mod utsname;
 
+#[allow(missing_docs)]
 pub mod wait;
 
 #[cfg(any(target_os = "android", target_os = "linux"))]
+#[allow(missing_docs)]
 pub mod inotify;
 
 #[cfg(target_os = "linux")]
+#[allow(missing_docs)]
 pub mod timerfd;
diff --git a/src/sys/signal.rs b/src/sys/signal.rs
index 95663687..89bcc1a2 100644
--- a/src/sys/signal.rs
+++ b/src/sys/signal.rs
@@ -1,7 +1,7 @@
 // Portions of this file are Copyright 2014 The Rust Project Developers.
 // See https://www.rust-lang.org/policies/licenses.
 
-///! Operating system signals.
+//! Operating system signals.
 
 use crate::{Error, Result};
 use crate::errno::Errno;