Make references to other objects clickable.

Author: wmedrano

Cargo.toml

@@ -8,7 +8,7 @@ license = "MIT"
 name = "jack"
 readme = "README.md"
 repository = "https://github.com/RustAudio/rust-jack"
-version = "0.13.0"
+version = "0.13.1"
 
 [dependencies]
 bitflags = "2"

src/lib.rs

@@ -9,28 +9,28 @@
 //! # Client
 //!
 //! Typically, applications connect clients to the server. For the rust jack crate, a connection can
-//! be made with `client::Client::new`, which returns a `client::Client`.
+//! be made with [`client::Client::new`], which returns a [`client::Client`].
 //!
 //! The `Client` can query the server for information, register ports, and manage connections for
 //! ports.
 //!
 //! To commence processing audio/midi and other information in real-time, rust jack provides the
-//! `Client::activate_async`, which consumes the `Client`, an object that implements
+//! [`Client::activate_async`], which consumes the [`Client`], an object that implements
 //! `NotificationHandler` and an object that implements `ProcessHandler` and returns a
-//! `AsyncClient`. `AsyncClient` processes the data in real-time with the provided handlers.
+//! [`AsyncClient`]. [`AsyncClient`] processes the data in real-time with the provided handlers.
 //!
 //! # Port
 //!
-//! A `Client` may obtain port information through the `Client::port_by_id` and
-//! `Client::port_by_name` methods. These ports can be used to manage connections or to obtain port
+//! A [`Client`] may obtain port information through the [`Client::port_by_id`] and
+//! [`Client::port_by_name`] methods. These ports can be used to manage connections or to obtain port
 //! metadata, though their port data (audio buffers and midi buffers) cannot be accessed safely.
 //!
-//! Ports can be registered with the `Client::register_port` method. This requires a `PortSpec`. The
-//! jack crate comes with common specs such as `AudioIn`, `AudioOut`, `MidiIn`, and
-//! `MidiOut`.
+//! Ports can be registered with the [`Client::register_port`] method. This requires a [`PortSpec`]. The
+//! jack crate comes with common specs such as [`AudioIn`], [`AudioOut`], [`MidiIn`], and
+//! [`MidiOut`].
 //!
 //! To access the data of registered ports, use their specialized methods within a `ProcessHandler`
-//! callback. For example, `Port<AudioIn>::as_mut_slice` returns a audio buffer that can be written
+//! callback. For example, [`Port<AudioIn>::as_mut_slice`] returns a audio buffer that can be written
 //! to.
 
 #[allow(deprecated)]
@@ -54,7 +54,7 @@ pub use crate::transport::{
 };
 
 /// The underlying system bindings for JACK. Can be useful for using possibly experimental stuff
-/// through `jack_sys::library()`.
+/// through [`jack_sys::library()`].
 pub use jack_sys;
 
 mod client;

src/port/audio.rs

@@ -3,11 +3,11 @@ use std::slice;
 
 use crate::{Port, PortFlags, PortSpec, ProcessScope};
 
-/// `AudioIn` implements the `PortSpec` trait which, defines an
+/// [`AudioIn`] implements the [`PortSpec`] trait which, defines an
 /// endpoint for JACK. In this case, it is a readable 32 bit floating
 /// point buffer for audio.
 ///
-/// `AudioIn::buffer()` is used to gain access the buffer.
+/// [`AudioIn::buffer()`] is used to gain access the buffer.
 ///
 /// # Example
 /// ```
@@ -22,11 +22,11 @@ pub struct AudioIn {
     _internal: (),
 }
 
-/// `AudioOut` implements the `PortSpec` trait, which defines an
+/// [`AudioOut`] implements the [`PortSpec`] trait, which defines an
 /// endpoint for JACK. In this case, it is a mutable 32 bit floating
 /// point buffer for audio.
 ///
-/// `AudioOut::buffer()` is used to gain access the buffer.
+/// [`AudioOut::buffer()`] is used to gain access the buffer.
 ///
 /// # Example
 /// ```

src/port/midi.rs

@@ -16,14 +16,14 @@ pub struct RawMidi<'a> {
     pub bytes: &'a [u8],
 }
 
-/// `MidiIn` implements the `PortSpec` trait, which defines an endpoint for JACK. In this case, it
+/// [`MidiIn`] implements the [`PortSpec`] trait, which defines an endpoint for JACK. In this case, it
 /// defines midi input.
 #[derive(Copy, Clone, Debug, Default)]
 pub struct MidiIn {
     _internal: (),
 }
 
-/// `MidiOut` implements the `PortSpec` trait, which defines an endpoint for JACK. In this case, it
+/// [`MidiOut`] implements the [`PortSpec`] trait, which defines an endpoint for JACK. In this case, it
 /// defines a midi output.
 #[derive(Copy, Clone, Debug, Default)]
 pub struct MidiOut {
@@ -57,7 +57,7 @@ impl Port<MidiIn> {
     }
 }
 
-/// Iterate through Midi Messages within a `Port<MidiIn>`.
+/// Iterate through Midi Messages within a [`Port<MidiIn>`].
 #[derive(Debug, Clone)]
 pub struct MidiIter<'a> {
     buffer: *mut ::libc::c_void,

src/port/mod.rs

@@ -2,7 +2,7 @@ mod audio;
 mod midi;
 mod port_impl;
 
-/// Contains flag constants that may be used to create `PortFlags`.
+/// Contains flag constants that may be used to create [`PortFlags`].
 mod port_flags;
 
 pub use self::audio::{AudioIn, AudioOut};

src/transport.rs

@@ -28,7 +28,7 @@ pub enum TransportState {
     Starting,
 }
 
-/// A helper struct encapsulating both `TransportState` and `TransportPosition`.
+/// A helper struct encapsulating both [`TransportState`] and [`TransportPosition`].
 #[derive(Debug)]
 pub struct TransportStatePosition {
     pub pos: TransportPosition,
@@ -127,7 +127,7 @@ impl Transport {
     ///
     /// * May be called at any time by any client.
     /// * The new position takes effect in two process cycles.
-    /// * If there are slow-sync clients and the transport is already rolling, it will enter the `TransportState::Starting` state and begin invoking their sync_callbacks until ready.
+    /// * If there are slow-sync clients and the transport is already rolling, it will enter the [`TransportState::Starting`] state and begin invoking their sync_callbacks until ready.
     /// * This function is realtime-safe.
     pub fn reposition(&self, pos: &TransportPosition) -> Result<()> {
         Self::result_from_ffi(