warrence/grapherity
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix inline documentation after recent changes

Browse Source
This commit is contained in:
warrence
2026-08-17 10:16:54 +02:00
parent b4374174a9
commit 3d99501d4b
3 changed files with 10 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/lib.rs
+3 -3
View File
@@ -91,8 +91,7 @@
//! graph.degree(v); //! graph.degree(v);
//! ``` //! ```
//! //!
//! [`VertexMap`] and [`EdgeMap`] are not required to panic if provided with an invalid //! [`ElementMap`] is not required to panic if provided with an invalid vertex or edge.
//! vertex or edge.
//! //!
//! Vertices and edges are provided by the graph and not intended to be generated by users. //! Vertices and edges are provided by the graph and not intended to be generated by users.
//! //!
@@ -121,11 +120,12 @@
//! [`ElementMap`]: crate::maps::ElementMap //! [`ElementMap`]: crate::maps::ElementMap
//! [`AppendGraph`]: crate::models::AppendGraph //! [`AppendGraph`]: crate::models::AppendGraph
//! [`Graph`]: crate::models::Graph //! [`Graph`]: crate::models::Graph
//! [`traits`]: crate::traits
//! [`GraphTopology`]: crate::traits::GraphTopology //! [`GraphTopology`]: crate::traits::GraphTopology
//! [`GraphTopology::Edge`]: crate::traits::GraphTopology::Edge //! [`GraphTopology::Edge`]: crate::traits::GraphTopology::Edge
//! [`GraphTopology::Vertex`]: crate::traits::GraphTopology::Vertex //! [`GraphTopology::Vertex`]: crate::traits::GraphTopology::Vertex
//! [`GraphTopologyAddition`]: crate::traits::GraphTopologyAddition
//! [`GraphTopologyDeletion`]: crate::traits::GraphTopologyDeletion //! [`GraphTopologyDeletion`]: crate::traits::GraphTopologyDeletion
//! [`traits`]: crate::traits
#![warn(missing_docs)] #![warn(missing_docs)]
src/maps.rs
+3
View File
@@ -18,6 +18,9 @@ use std::ops::{Index, IndexMut};
/// ///
/// Use [`GraphTopology::vertex_map`] or [`GraphTopology::edge_map`] to obtain an `ElementMap` for /// Use [`GraphTopology::vertex_map`] or [`GraphTopology::edge_map`] to obtain an `ElementMap` for
/// vertices or edges, respectively. /// 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> { pub struct ElementMap<E: Copy, T: Clone> {
data: Vec<T>, data: Vec<T>,
default: T, default: T,
src/traits.rs
+4
View File
@@ -190,6 +190,8 @@ pub trait GraphTopologyAddition: GraphTopology {
/// ///
/// Use this before adding multiple vertices to avoid incremental growth on each call to /// Use this before adding multiple vertices to avoid incremental growth on each call to
/// [`add_vertex`]. /// [`add_vertex`].
///
/// [`add_vertex`]: GraphTopologyAddition::add_vertex
fn reserve_vertices(&mut self, additional: usize); fn reserve_vertices(&mut self, additional: usize);
/// Reserves capacity for at least `additional` more edges. Does nothing if capacity is already /// 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 /// Use this before adding multiple edges to avoid incremental growth on each call to
/// [`add_edge`]. /// [`add_edge`].
///
/// [`add_edge`]: GraphTopologyAddition::add_edge
fn reserve_edges(&mut self, additional: usize); fn reserve_edges(&mut self, additional: usize);
/// Adds a new isolated vertex and returns its handle. /// Adds a new isolated vertex and returns its handle.