Expand description
Automated documentation generator from National Instruments TestStand™ sequences.
Generates rich Markdown documentation from sequence files (.seq), including:
- Complete step flow and properties
- Control flow diagrams using native Mermaid rendering
- Code module dependencies
- Variables across scopes (Locals, Parameters, FileGlobals, StationGlobals)
- Station options and custom types
§Safety
All COM interactions are managed via rs_teststand; this crate forbids
unsafe code completely.
Re-exports§
pub use data::CustomDataType;pub use data::ExtractorConfig;pub use data::FileData;pub use data::Limits;pub use data::MeasurementData;pub use data::ModuleInfo;pub use data::Profile;pub use data::SequenceCategory;pub use data::SequenceData;pub use data::StepData;pub use data::Variable;pub use data::VariableScope;pub use error::Error;pub use extraction::HierarchyExtractor;pub use rendering::Formatter;
Modules§
- cli
- Granular command-line interface submodules.
- constants
- Constants, enums, and mappings for the autodoc generator.
- data
- Data models for extracted TestStand™ sequences and settings.
- error
- Error types for the autodoc generator.
- extraction
- Sequence file extraction and hierarchy analysis modules.
- rendering
- Rendering modules for Markdown and Mermaid diagrams.
- rules
- What a document contains, as data rather than as branches.