Fix inline documentation after recent changes
This commit is contained in:
+3
-3
@@ -91,8 +91,7 @@
|
||||
//! graph.degree(v);
|
||||
//! ```
|
||||
//!
|
||||
//! [`VertexMap`] and [`EdgeMap`] are not required to panic if provided with an invalid
|
||||
//! vertex or edge.
|
||||
//! [`ElementMap`] is not required to panic if provided with an invalid vertex or edge.
|
||||
//!
|
||||
//! Vertices and edges are provided by the graph and not intended to be generated by users.
|
||||
//!
|
||||
@@ -121,11 +120,12 @@
|
||||
//! [`ElementMap`]: crate::maps::ElementMap
|
||||
//! [`AppendGraph`]: crate::models::AppendGraph
|
||||
//! [`Graph`]: crate::models::Graph
|
||||
//! [`traits`]: crate::traits
|
||||
//! [`GraphTopology`]: crate::traits::GraphTopology
|
||||
//! [`GraphTopology::Edge`]: crate::traits::GraphTopology::Edge
|
||||
//! [`GraphTopology::Vertex`]: crate::traits::GraphTopology::Vertex
|
||||
//! [`GraphTopologyAddition`]: crate::traits::GraphTopologyAddition
|
||||
//! [`GraphTopologyDeletion`]: crate::traits::GraphTopologyDeletion
|
||||
//! [`traits`]: crate::traits
|
||||
|
||||
#![warn(missing_docs)]
|
||||
|
||||
|
||||
@@ -18,6 +18,9 @@ use std::ops::{Index, IndexMut};
|
||||
///
|
||||
/// Use [`GraphTopology::vertex_map`] or [`GraphTopology::edge_map`] to obtain an `ElementMap` for
|
||||
/// vertices or edges, respectively.
|
||||
///
|
||||
/// [`GraphTopology::edge_map`]: crate::traits::GraphTopology::edge_map
|
||||
/// [`GraphTopology::vertex_map`]: crate::traits::GraphTopology::vertex_map
|
||||
pub struct ElementMap<E: Copy, T: Clone> {
|
||||
data: Vec<T>,
|
||||
default: T,
|
||||
|
||||
@@ -190,6 +190,8 @@ pub trait GraphTopologyAddition: GraphTopology {
|
||||
///
|
||||
/// Use this before adding multiple vertices to avoid incremental growth on each call to
|
||||
/// [`add_vertex`].
|
||||
///
|
||||
/// [`add_vertex`]: GraphTopologyAddition::add_vertex
|
||||
fn reserve_vertices(&mut self, additional: usize);
|
||||
|
||||
/// Reserves capacity for at least `additional` more edges. Does nothing if capacity is already
|
||||
@@ -197,6 +199,8 @@ pub trait GraphTopologyAddition: GraphTopology {
|
||||
///
|
||||
/// Use this before adding multiple edges to avoid incremental growth on each call to
|
||||
/// [`add_edge`].
|
||||
///
|
||||
/// [`add_edge`]: GraphTopologyAddition::add_edge
|
||||
fn reserve_edges(&mut self, additional: usize);
|
||||
|
||||
/// Adds a new isolated vertex and returns its handle.
|
||||
|
||||
Reference in New Issue
Block a user