Autorouter: general modules descriptions

This commit is contained in:
hakki 2024-10-02 18:16:07 +02:00
parent 3fb01e9f48
commit 43c83bb733
6 changed files with 8 additions and 7 deletions

View File

@ -1,5 +1,4 @@
//! This module defines the Invoker structure, which manages the execution of //! Manages the execution of routing commands within the autorouting system.
//! routing commands within the autorouting system.
use std::cmp::Ordering; use std::cmp::Ordering;

View File

@ -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 //! bands in a PCB layout. It interacts with the autorouter to calculate and return
//! the length of specified band selections. //! the length of specified band selections.

View File

@ -1,3 +1,5 @@
//! Manages autorouting process, under work for now
pub mod autoroute; pub mod autoroute;
mod autorouter; mod autorouter;
pub mod command; pub mod command;

View File

@ -1,5 +1,5 @@
//! This module provides functionality for placing vias in a PCB layout. //! Provides functionality for placing vias in a PCB layout, manages
//! It manages the process of inserting a via with a specified weight and //! the process of inserting a via with a specified weight and
//! checks if the via has already been placed. //! checks if the via has already been placed.
use crate::{ use crate::{

View File

@ -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 //! used in layout triangulation and routing tasks. It includes vertex and edge
//! structures for representing graph nodes and edges with associated metadata, //! structures for representing graph nodes and edges with associated metadata,
//! as well as functions for constructing and manipulating these graphs. //! as well as functions for constructing and manipulating these graphs.

View File

@ -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 //! autorouting context. It defines a struct that interacts with the autorouter
//! to remove selected bands, and implements necessary traits for working //! to remove selected bands, and implements necessary traits for working
//! with navigation meshes, traces, and obstacles. //! with navigation meshes, traces, and obstacles.