Document the Output associated types

Author: fengalin

src/add.rs

@@ -16,6 +16,7 @@ use crate::{Error, OptionOperations};
 /// This trait is auto-implemented for [`OptionOperations`] types
 /// implementing `Add<Rhs>`.
 pub trait OptionAdd<Rhs, InnerRhs = Rhs> {
+    /// The resulting inner type after applying the operation.
     type Output;
 
     /// Computes the addition.
@@ -191,6 +192,7 @@ where
 /// Note that since the `std` library doesn't define any `CheckedAdd` trait,
 /// users must provide the base implementation for the inner type.
 pub trait OptionCheckedAdd<Rhs = Self, InnerRhs = Rhs> {
+    /// The resulting inner type after applying the operation.
     type Output;
 
     /// Computes the checked addition.
@@ -313,6 +315,7 @@ impl OptionCheckedAdd<std::time::Duration> for std::time::SystemTime {
 /// Note that since the `std` library doesn't define any `OverflowingAdd`
 /// trait, users must provide the base implementation for the inner type.
 pub trait OptionOverflowingAdd<Rhs = Self, InnerRhs = Rhs> {
+    /// The resulting inner type after applying the operation.
     type Output;
 
     /// Returns a tuple of the addition along with a boolean indicating
@@ -403,6 +406,7 @@ impl_for_ints!(OptionOverflowingAdd, {
 /// Note that since the `std` library doesn't define any `SaturatingAdd`
 /// trait, users must provide the base implementation for the inner type.
 pub trait OptionSaturatingAdd<Rhs = Self, InnerRhs = Rhs> {
+    /// The resulting inner type after applying the operation.
     type Output;
 
     /// Computes the addition, saturating at the numeric bounds instead of
@@ -492,6 +496,7 @@ impl_for_ints_and_duration!(OptionSaturatingAdd, {
 /// Note that since the `std` library doesn't define any `WrappingAdd`
 /// trait, users must provide the base implementation for the inner type.
 pub trait OptionWrappingAdd<Rhs = Self, InnerRhs = Rhs> {
+    /// The resulting inner type after applying the operation.
     type Output;
 
     /// Computes the addition, wrapping around at the numeric bounds

src/div.rs

@@ -16,6 +16,7 @@ use crate::{Error, OptionOperations};
 /// This trait is auto-implemented for [`OptionOperations`] types
 /// implementing `Div<Rhs>`.
 pub trait OptionDiv<Rhs, InnerRhs = Rhs> {
+    /// The resulting inner type after applying the operation.
     type Output;
 
     /// Computes the division.
@@ -199,6 +200,7 @@ where
 /// Note that since the `std` library doesn't define any `CheckedDiv` trait,
 /// users must provide the base implementation for the inner type.
 pub trait OptionCheckedDiv<Rhs = Self, InnerRhs = Rhs> {
+    /// The resulting inner type after applying the operation.
     type Output;
 
     /// Computes the checked division.
@@ -319,6 +321,7 @@ impl OptionCheckedDiv<u32> for core::time::Duration {
 /// Note that since the `std` library doesn't define any `OverflowingDiv`
 /// trait, users must provide the base implementation for the inner type.
 pub trait OptionOverflowingDiv<Rhs = Self, InnerRhs = Rhs> {
+    /// The resulting inner type after applying the operation.
     type Output;
 
     /// Returns a tuple of the division along with a boolean indicating
@@ -413,6 +416,7 @@ impl_for_ints!(OptionOverflowingDiv, {
 /// Note that since the `std` library doesn't define any `WrappingDiv`
 /// trait, users must provide the base implementation for the inner type.
 pub trait OptionWrappingDiv<Rhs = Self, InnerRhs = Rhs> {
+    /// The resulting inner type after applying the operation.
     type Output;
 
     /// Computes the division, wrapping around at the numeric bounds

src/mul.rs

@@ -16,6 +16,7 @@ use crate::{Error, OptionOperations};
 /// This trait is auto-implemented for [`OptionOperations`] types
 /// implementing `Mul<Rhs>`.
 pub trait OptionMul<Rhs, InnerRhs = Rhs> {
+    /// The resulting inner type after applying the operation.
     type Output;
 
     /// Computes the multiplication.
@@ -191,6 +192,7 @@ where
 /// Note that since the `std` library doesn't define any `CheckedMul` trait,
 /// users must provide the base implementation for the inner type.
 pub trait OptionCheckedMul<Rhs = Self, InnerRhs = Rhs> {
+    /// The resulting inner type after applying the operation.
     type Output;
 
     /// Computes the checked multiplication.
@@ -304,6 +306,7 @@ impl OptionCheckedMul<u32> for core::time::Duration {
 /// Note that since the `std` library doesn't define any `OverflowingMul`
 /// trait, users must provide the base implementation for the inner type.
 pub trait OptionOverflowingMul<Rhs = Self, InnerRhs = Rhs> {
+    /// The resulting inner type after applying the operation.
     type Output;
 
     /// Returns a tuple of the multiplication along with a boolean indicating
@@ -394,6 +397,7 @@ impl_for_ints!(OptionOverflowingMul, {
 /// Note that since the `std` library doesn't define any `SaturatingMul`
 /// trait, users must provide the base implementation for the inner type.
 pub trait OptionSaturatingMul<Rhs = Self, InnerRhs = Rhs> {
+    /// The resulting inner type after applying the operation.
     type Output;
 
     /// Computes the multiplication, saturating at the numeric bounds instead of
@@ -490,6 +494,7 @@ impl OptionSaturatingMul<u32> for core::time::Duration {
 /// Note that since the `std` library doesn't define any `WrappingMul`
 /// trait, users must provide the base implementation for the inner type.
 pub trait OptionWrappingMul<Rhs = Self, InnerRhs = Rhs> {
+    /// The resulting inner type after applying the operation.
     type Output;
 
     /// Computes the multiplication, wrapping around at the numeric bounds

src/rem.rs

@@ -16,6 +16,7 @@ use crate::{Error, OptionOperations};
 /// This trait is auto-implemented for [`OptionOperations`] types
 /// implementing `Rem<Rhs>`.
 pub trait OptionRem<Rhs, InnerRhs = Rhs> {
+    /// The resulting inner type after applying the operation.
     type Output;
 
     /// Computes the remainder.
@@ -199,6 +200,7 @@ where
 /// Note that since the `std` library doesn't define any `CheckedRem` trait,
 /// users must provide the base implementation for the inner type.
 pub trait OptionCheckedRem<Rhs = Self, InnerRhs = Rhs> {
+    /// The resulting inner type after applying the operation.
     type Output;
 
     /// Computes the checked remainder.
@@ -309,6 +311,7 @@ impl_for_ints!(OptionCheckedRem, {
 /// Note that since the `std` library doesn't define any `OverflowingRem`
 /// trait, users must provide the base implementation for the inner type.
 pub trait OptionOverflowingRem<Rhs = Self, InnerRhs = Rhs> {
+    /// The resulting inner type after applying the operation.
     type Output;
 
     /// Returns a tuple of the remainder along with a boolean indicating
@@ -403,6 +406,7 @@ impl_for_ints!(OptionOverflowingRem, {
 /// Note that since the `std` library doesn't define any `WrappingRem`
 /// trait, users must provide the base implementation for the inner type.
 pub trait OptionWrappingRem<Rhs = Self, InnerRhs = Rhs> {
+    /// The resulting inner type after applying the operation.
     type Output;
 
     /// Computes the remainder, wrapping around at the numeric bounds

src/sub.rs

@@ -16,6 +16,7 @@ use crate::{Error, OptionOperations};
 /// This trait is auto-implemented for [`OptionOperations`] types
 /// implementing `Sub<Rhs>`.
 pub trait OptionSub<Rhs, InnerRhs = Rhs> {
+    /// The resulting inner type after applying the operation.
     type Output;
 
     /// Computes the substraction.
@@ -191,6 +192,7 @@ where
 /// Note that since the `std` library doesn't define any `CheckedSub` trait,
 /// users must provide the base implementation for the inner type.
 pub trait OptionCheckedSub<Rhs = Self, InnerRhs = Rhs> {
+    /// The resulting inner type after applying the operation.
     type Output;
 
     /// Computes the checked substraction.
@@ -313,6 +315,7 @@ impl OptionCheckedSub<std::time::Duration> for std::time::SystemTime {
 /// Note that since the `std` library doesn't define any `OverflowingSub`
 /// trait, users must provide the base implementation for the inner type.
 pub trait OptionOverflowingSub<Rhs = Self, InnerRhs = Rhs> {
+    /// The resulting inner type after applying the operation.
     type Output;
 
     /// Returns a tuple of the substraction along with a boolean indicating
@@ -403,6 +406,7 @@ impl_for_ints!(OptionOverflowingSub, {
 /// Note that since the `std` library doesn't define any `SaturatingSub`
 /// trait, users must provide the base implementation for the inner type.
 pub trait OptionSaturatingSub<Rhs = Self, InnerRhs = Rhs> {
+    /// The resulting inner type after applying the operation.
     type Output;
 
     /// Computes the substraction, saturating at the numeric bounds instead of
@@ -492,6 +496,7 @@ impl_for_ints_and_duration!(OptionSaturatingSub, {
 /// Note that since the `std` library doesn't define any `WrappingSub`
 /// trait, users must provide the base implementation for the inner type.
 pub trait OptionWrappingSub<Rhs = Self, InnerRhs = Rhs> {
+    /// The resulting inner type after applying the operation.
     type Output;
 
     /// Computes the substraction, wrapping around at the numeric bounds