Skip to main content

rs_teststand_autodoc/
lib.rs

1//! Automated documentation generator from National Instruments TestStand™ sequences.
2//!
3//! Generates rich Markdown documentation from sequence files (`.seq`), including:
4//! - Complete step flow and properties
5//! - Control flow diagrams using native Mermaid rendering
6//! - Code module dependencies
7//! - Variables across scopes (Locals, Parameters, FileGlobals, StationGlobals)
8//! - Station options and custom types
9//!
10//! # Safety
11//!
12//! All COM interactions are managed via [`rs_teststand`]; this crate forbids
13//! `unsafe` code completely.
14
15#![forbid(unsafe_code)]
16
17pub mod cli;
18pub mod constants;
19pub mod data;
20pub mod error;
21pub mod extraction;
22pub mod rendering;
23pub mod rules;
24
25pub use data::{
26    CustomDataType, ExtractorConfig, FileData, Limits, MeasurementData, ModuleInfo, Profile,
27    SequenceCategory, SequenceData, StepData, Variable, VariableScope,
28};
29pub use error::Error;
30pub use extraction::HierarchyExtractor;
31pub use rendering::Formatter;