Document epoll, and remove the last allow(missing_docs) overrides.

Author: sunfishcode

src/imp/libc/io/epoll.rs

@@ -54,8 +54,6 @@
 //! # }
 //! ```
 
-#![allow(missing_docs)] // TODO: Write more docs.
-
 use super::super::c;
 use super::super::conv::{ret, ret_owned_fd, ret_u32};
 use crate::fd::{AsFd, AsRawFd, BorrowedFd, RawFd};
@@ -442,6 +440,7 @@ impl<'context, T: AsFd + IntoFd + FromFd> From<OwnedFd> for Epoll<Owning<'contex
     }
 }
 
+/// An iterator over the `Event`s in an `EventVec`.
 pub struct Iter<'context, Context: self::Context> {
     iter: core::slice::Iter<'context, Event>,
     context: *const Context,
@@ -484,13 +483,15 @@ struct Event {
     encoded: u64,
 }
 
+/// A vector of `Event`s, plus context for interpreting them.
 pub struct EventVec<'context, Context: self::Context> {
     events: Vec<Event>,
     context: *const Context,
     _phantom: PhantomData<&'context Context>,
 }
 
 impl<'context, Context: self::Context> EventVec<'context, Context> {
+    /// Constructs an `EventVec` with memory for `capacity` `Event`s.
     #[inline]
     pub fn with_capacity(capacity: usize) -> Self {
         Self {
@@ -500,31 +501,37 @@ impl<'context, Context: self::Context> EventVec<'context, Context> {
         }
     }
 
+    /// Returns the current `Event` capacity of this `EventVec`.
     #[inline]
     pub fn capacity(&self) -> usize {
         self.events.capacity()
     }
 
+    /// Reserves enough memory for at least `additional` more `Event`s.
     #[inline]
     pub fn reserve(&mut self, additional: usize) {
         self.events.reserve(additional);
     }
 
+    /// Reserves enough memory for exactly `additional` more `Event`s.
     #[inline]
     pub fn reserve_exact(&mut self, additional: usize) {
         self.events.reserve_exact(additional);
     }
 
+    /// Clears all the `Events` out of this `EventVec`.
     #[inline]
     pub fn clear(&mut self) {
         self.events.clear();
     }
 
+    /// Shrinks the capacity of this `EventVec` as much as possible.
     #[inline]
     pub fn shrink_to_fit(&mut self) {
         self.events.shrink_to_fit();
     }
 
+    /// Returns an iterator over the `Event`s in this `EventVec`.
     #[inline]
     pub fn iter(&self) -> Iter<'_, Context> {
         Iter {
@@ -534,6 +541,7 @@ impl<'context, Context: self::Context> EventVec<'context, Context> {
         }
     }
 
+    /// Returns the number of `Event`s logically contained in this `EventVec`.
     #[inline]
     pub fn len(&mut self) -> usize {
         self.events.len()

src/imp/linux_raw/io/epoll.rs

@@ -55,7 +55,6 @@
 //! ```
 
 #![allow(unsafe_code)]
-#![allow(missing_docs)] // TODO: Write more docs.
 
 use super::super::c;
 use crate::fd::{AsFd, AsRawFd, BorrowedFd, RawFd};
@@ -432,6 +431,7 @@ impl<'context, T: AsFd + IntoFd + FromFd> From<OwnedFd> for Epoll<Owning<'contex
     }
 }
 
+/// An iterator over the `Event`s in an `EventVec`.
 pub struct Iter<'context, Context: self::Context> {
     iter: core::slice::Iter<'context, Event>,
     context: *const Context,
@@ -465,13 +465,15 @@ struct Event {
     encoded: u64,
 }
 
+/// A vector of `Event`s, plus context for interpreting them.
 pub struct EventVec<'context, Context: self::Context> {
     events: Vec<Event>,
     context: *const Context,
     _phantom: PhantomData<&'context Context>,
 }
 
 impl<'context, Context: self::Context> EventVec<'context, Context> {
+    /// Constructs an `EventVec` with memory for `capacity` `Event`s.
     #[inline]
     pub fn with_capacity(capacity: usize) -> Self {
         Self {
@@ -481,31 +483,37 @@ impl<'context, Context: self::Context> EventVec<'context, Context> {
         }
     }
 
+    /// Returns the current `Event` capacity of this `EventVec`.
     #[inline]
     pub fn capacity(&self) -> usize {
         self.events.capacity()
     }
 
+    /// Reserves enough memory for at least `additional` more `Event`s.
     #[inline]
     pub fn reserve(&mut self, additional: usize) {
         self.events.reserve(additional);
     }
 
+    /// Reserves enough memory for exactly `additional` more `Event`s.
     #[inline]
     pub fn reserve_exact(&mut self, additional: usize) {
         self.events.reserve_exact(additional);
     }
 
+    /// Clears all the `Events` out of this `EventVec`.
     #[inline]
     pub fn clear(&mut self) {
         self.events.clear();
     }
 
+    /// Shrinks the capacity of this `EventVec` as much as possible.
     #[inline]
     pub fn shrink_to_fit(&mut self) {
         self.events.shrink_to_fit();
     }
 
+    /// Returns an iterator over the `Event`s in this `EventVec`.
     #[inline]
     pub fn iter(&self) -> Iter<'_, Context> {
         Iter {
@@ -515,6 +523,7 @@ impl<'context, Context: self::Context> EventVec<'context, Context> {
         }
     }
 
+    /// Returns the number of `Event`s logically contained in this `EventVec`.
     #[inline]
     pub fn len(&mut self) -> usize {
         self.events.len()

src/imp/linux_raw/io/io_slice.rs

@@ -3,7 +3,6 @@
 //! dca3f1b786efd27be3b325ed1e01e247aa589c3b.
 
 #![allow(unsafe_code)]
-#![allow(missing_docs)]
 
 use super::c;
 use core::marker::PhantomData;