misc: fix up intra doc links (make use of rfc 1946)

rrbutani · rrbutani · commit 6fc4e6b95b67 · 2019-10-09T18:56:21.000-05:00
See: https://rust-lang.github.io/rfcs/1946-intra-rustdoc-links.html and: rust-lang/rust#47046 🎉
diff --git a/src/control.rs b/src/control.rs
@@ -1,9 +1,9 @@
-//! The [`Control` trait](trait.Control.html) and friends.
+//! The [`Control` trait](crate::control::Control) and friends.
 //!
-//! Unlike the [`Peripherals` trait](../peripherals/trait.Peripherals.html) and
-//! the [`Memory` trait](../memory/trait.Memory.html), there is no shim
-//! implementation of Control; instead the 'shim' is an instruction level
-//! simulator that lives in the [interp module](../interp).
+//! Unlike the [`Peripherals` trait](crate::peripherals::Peripherals) and the
+//! [`Memory` trait](crate::memory::Memory), there is no shim implementation of
+//! Control; instead the 'shim' is an instruction level simulator that lives in
+//! the [interp module](crate::interp).
 
 use super::error::Error;
 use super::{Addr, Word};
diff --git a/src/lib.rs b/src/lib.rs
@@ -1,5 +1,6 @@
 #![feature(stmt_expr_attributes)]
 #![feature(trace_macros)]
+
 // TODO: forbid
 #![warn(
     bad_style,
@@ -27,6 +28,7 @@
 // TODO: deny
 #![warn(
     missing_debug_implementations,
+    intra_doc_link_resolution_failure,
     missing_docs,
     unsafe_code,
     trivial_casts,
@@ -36,11 +38,12 @@
     unused_qualifications,
     unused_results
 )]
+
 // Mark the crate as no_std if the `no_std` feature is enabled.
 #![cfg_attr(feature = "no_std", no_std)]
 
 #[cfg(feature = "shims")]
-mod shims;
+pub mod shims;
 
 // Can't have `no_std` and `shims` enabled!
 #[cfg(all(feature = "no_std", feature = "shims"))]
diff --git a/src/peripherals/adc.rs b/src/peripherals/adc.rs
@@ -1,4 +1,4 @@
-//! [`Adc` trait](trait.Adc.html) and associated types.
+//! [`Adc` trait](Adc) and associated types.
 
 use crate::peripheral_trait;
 
diff --git a/src/peripherals/clock.rs b/src/peripherals/clock.rs
@@ -1,4 +1,4 @@
-//! [`Clock` trait](trait.Clock.html).
+//! [`Clock` trait](Clock).
 
 use crate::Word;
 
diff --git a/src/peripherals/gpio.rs b/src/peripherals/gpio.rs
@@ -1,4 +1,4 @@
-//! [`Gpio` trait](trait.Gpio.html) and friends.
+//! [`Gpio` trait](Gpio) and friends.
 
 use core::convert::TryFrom;
 
diff --git a/src/peripherals/input.rs b/src/peripherals/input.rs
@@ -1,3 +1,3 @@
-//! [`Input` device trait](trait.Input.html) and related things.
+//! [`Input` device trait](Input) and related things.
 
 pub trait Input {}
diff --git a/src/peripherals/mod.rs b/src/peripherals/mod.rs
@@ -1,5 +1,5 @@
-//! Peripherals! The [`Peripherals` supertrait](trait.Peripherals.html) and the
-//! rest of the peripheral and device traits.
+//! Peripherals! The [`Peripherals` supertrait](Peripherals) and the rest of the
+//! peripheral and device traits.
 
 pub mod adc;
 pub mod clock;
diff --git a/src/peripherals/output.rs b/src/peripherals/output.rs
@@ -1,3 +1,3 @@
-//! [`Output` device trait](trait.Output.html) and friends.
+//! [`Output` device trait](Output) and friends.
 
 pub trait Output {}
diff --git a/src/peripherals/pwm.rs b/src/peripherals/pwm.rs
@@ -1,4 +1,4 @@
-//! [`Pwm` trait](trait.Pwm.html) and helpers.
+//! [`Pwm` trait](Pwm) and helpers.
 
 // TODO: Switch to enum for pins
 // TODO: Add Errors
diff --git a/src/peripherals/timers.rs b/src/peripherals/timers.rs
@@ -1,4 +1,4 @@
-//! [`Timers` trait](trait.Timers.html) and related types.
+//! [`Timers` trait](Timers) and related types.
 
 use crate::Word;
 
diff --git a/src/shims/memory.rs b/src/shims/memory.rs
@@ -1,7 +1,10 @@
-//! An extremely naive, terrible [`Memory` trait](../memory/trait.Memory.html)
-//! implementation called [`MemoryShim`](struct.MemoryShim.html).
+//! An extremely naive, terrible [`Memory` trait](crate::memory::Memory)
+//! implementation called [`MemoryShim`](memory::MemoryShim).
 
-/// Naive [`Memory` trait](../memory/trait.Memory.html) implementation.
+use crate::{Addr, Word};
+use crate::memory::{Memory, MemoryMiscError};
+
+/// Naive [`Memory` trait](crate::memory::Memory) implementation.
 ///
 /// Only good for hosted platforms since we just go and use 128 KiB of stack
 /// space.
diff --git a/src/shims/mod.rs b/src/shims/mod.rs
@@ -1,9 +1,10 @@
-//! Shims for the various [peripheral](../peripheral) traits and for the
-//! [`Memory` trait](../memory/trait.Memory.html).
+//! Shims for the various [peripheral](crate::peripherals) traits and for the
+//! [`Memory` trait](crate::memory::Memory).
 
 // Peripherals:
 mod gpio;
 
 // Devices:
 
 // Memory:
+mod memory;

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		-//! [`Adc` trait](trait.Adc.html) and associated types.
	`1`	+//! [`Adc` trait](Adc) and associated types.
`2`	`2`
`3`	`3`	`use crate::peripheral_trait;`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		-//! [`Clock` trait](trait.Clock.html).
	`1`	+//! [`Clock` trait](Clock).
`2`	`2`
`3`	`3`	`use crate::Word;`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		-//! [`Gpio` trait](trait.Gpio.html) and friends.
	`1`	+//! [`Gpio` trait](Gpio) and friends.
`2`	`2`
`3`	`3`	`use core::convert::TryFrom;`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`		-//! [`Input` device trait](trait.Input.html) and related things.
	`1`	+//! [`Input` device trait](Input) and related things.
`2`	`2`
`3`	`3`	`pub trait Input {}`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`		-//! [`Output` device trait](trait.Output.html) and friends.
	`1`	+//! [`Output` device trait](Output) and friends.
`2`	`2`
`3`	`3`	`pub trait Output {}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		-//! [`Pwm` trait](trait.Pwm.html) and helpers.
	`1`	+//! [`Pwm` trait](Pwm) and helpers.
`2`	`2`
`3`	`3`	`// TODO: Switch to enum for pins`
`4`	`4`	`// TODO: Add Errors`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		-//! [`Timers` trait](trait.Timers.html) and related types.
	`1`	+//! [`Timers` trait](Timers) and related types.
`2`	`2`
`3`	`3`	`use crate::Word;`
`4`	`4`