diff --git a/src/autorouter/invoker.rs b/src/autorouter/invoker.rs index e923704..3fb76e2 100644 --- a/src/autorouter/invoker.rs +++ b/src/autorouter/invoker.rs @@ -1,5 +1,4 @@ -//! This module defines the Invoker structure, which manages the execution of -//! routing commands within the autorouting system. +//! Manages the execution of routing commands within the autorouting system. use std::cmp::Ordering; diff --git a/src/autorouter/measure_length.rs b/src/autorouter/measure_length.rs index 2f0b9c9..c20e70a 100644 --- a/src/autorouter/measure_length.rs +++ b/src/autorouter/measure_length.rs @@ -1,4 +1,4 @@ -//! This module provides functionality for measuring the total length of selected +//! Provides functionality for measuring the total length of selected //! bands in a PCB layout. It interacts with the autorouter to calculate and return //! the length of specified band selections. diff --git a/src/autorouter/mod.rs b/src/autorouter/mod.rs index 1c638b3..c161fe0 100644 --- a/src/autorouter/mod.rs +++ b/src/autorouter/mod.rs @@ -1,3 +1,5 @@ +//! Manages autorouting process, under work for now + pub mod autoroute; mod autorouter; pub mod command; diff --git a/src/autorouter/place_via.rs b/src/autorouter/place_via.rs index 31b2d69..e6de21a 100644 --- a/src/autorouter/place_via.rs +++ b/src/autorouter/place_via.rs @@ -1,5 +1,5 @@ -//! This module provides functionality for placing vias in a PCB layout. -//! It manages the process of inserting a via with a specified weight and +//! Provides functionality for placing vias in a PCB layout, manages +//! the process of inserting a via with a specified weight and //! checks if the via has already been placed. use crate::{ diff --git a/src/autorouter/ratsnest.rs b/src/autorouter/ratsnest.rs index c901e67..80dd9a9 100644 --- a/src/autorouter/ratsnest.rs +++ b/src/autorouter/ratsnest.rs @@ -1,4 +1,4 @@ -//! This module defines data structures and methods for managing a graph +//! Defines data structures and methods for managing a graph //! used in layout triangulation and routing tasks. It includes vertex and edge //! structures for representing graph nodes and edges with associated metadata, //! as well as functions for constructing and manipulating these graphs. diff --git a/src/autorouter/remove_bands.rs b/src/autorouter/remove_bands.rs index 5187adc..272ca66 100644 --- a/src/autorouter/remove_bands.rs +++ b/src/autorouter/remove_bands.rs @@ -1,4 +1,4 @@ -//! This module provides functionality to remove bands from the layout in an +//! Provides functionality to remove bands from the layout in an //! autorouting context. It defines a struct that interacts with the autorouter //! to remove selected bands, and implements necessary traits for working //! with navigation meshes, traces, and obstacles.