Skip to content

Commit

Permalink
Merge pull request #5 from dopsi/master
Browse files Browse the repository at this point in the history
Fix documentation links
  • Loading branch information
hellow554 authored Aug 19, 2019
2 parents a2c90f3 + b818e15 commit 70da7a8
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 6 deletions.
5 changes: 3 additions & 2 deletions src/models/gates/mod.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
//! This module provides logic gates that work with [`Ieee1164`], e.g. [`AndGate`], [`OrGate`],
//! [`Buffer`], [`Mux`], etc.
//! This module provides logic gates that work with [`Ieee1164`](crate::Ieee1164), e.g.
//! [`AndGate`](crate::models::gates::AndGate), [`OrGate`](crate::models::gates::OrGate),
//! [`Buffer`](crate::models::gates::Buffer), [`Mux`](crate::models::gates::Mux), etc.
mod mux;
mod tri;
Expand Down
2 changes: 1 addition & 1 deletion src/models/gates/tri.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ use crate::direction::{Input, Output};
use crate::dump::IterPorts;
use crate::{Ieee1164, Port, Updateable};

/// A `Tristate-buffer` can be used if you need multiple signals to drive a single [`Signal`].
/// A `Tristate-buffer` can be used if you need multiple signals to drive a single [`Signal`](crate::Signal).
///
/// This is often used if multiple signals must drive a single one, e.g. a s.c. bus. If [`TriBuffer::s`] is
/// driven high, [`TriBuffer::z`] will be the value of [`TriBuffer::a`]. If it's driven low, it will
Expand Down
4 changes: 3 additions & 1 deletion src/models/mod.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
//! This module will contain different models that can be used to perform certain calculations. E.g.
//! Gates, like [`AndGate`], [`Mux`], [`Switch`], but also complex gates, like ['Alu`] or [`Rom1kx8`].
//! Gates, like [`AndGate`](crate::models::gates::AndGate), [`Mux`](crate::models::gates::Mux),
//! [`Switch`](crate::models::inputs::Switch), but also complex gates, like
//! [`Rom1kx8`](crate::models::rtlib::memory::rom::Rom1kx8).
pub mod gates;
pub mod inputs;
Expand Down
3 changes: 2 additions & 1 deletion src/models/rtlib/memory/rom.rs
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ use crate::{Ieee1164, LogicVector, Port, Updateable};
/// output-enable line which can be used to control the data output to be [`Ieee1164::_Z`]
/// (high-impedance) instead of outputting a value.
///
/// Althought it's a `Rom`, you can modify the values inside programmatically, but not with `Signals`.
/// Althought it's a `Rom`, you can modify the values inside programmatically, but not with
/// [`Signals`](crate::Signal).
///
/// # Examples
///
Expand Down
2 changes: 1 addition & 1 deletion src/port/portdirection.rs
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ impl MaybeWrite for Off {}

/// Trait for describing a `PortDirection`.
///
/// This is used for the [`Port`] struct so it can offer or
/// This is used for the [`Port`](crate::port::Port) struct so it can offer or
/// decline certain functions at compile time, e.g. reading an `Output` `Port` should not be
/// possible, but only writing to it.
///
Expand Down

0 comments on commit 70da7a8

Please sign in to comment.