Skip to content

Commit 0c38b77

Browse files
committed
release: plcviz-0.2.1
1 parent 4d93777 commit 0c38b77

4 files changed

Lines changed: 27 additions & 12 deletions

File tree

‎Cargo.lock‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎plcviz/CHANGELOG.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
# Changelog
22

3-
## 0.2.0 (2024-12-04)
3+
## 0.2.1 (2024-12-05)
4+
- Changes in docs
45

6+
## 0.2.0 (2024-12-04)
57
- Added dataflow graph type
68
- Added `--stats` option
79

810
## 0.1.0 (2024-12-01)
9-
1011
- Initial release
1112
- Structure, call, combined graph types
1213
- SVG output with layout-rs

‎plcviz/Cargo.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "plcviz"
3-
version = "0.2.0"
3+
version = "0.2.1"
44
edition = "2021"
55
description = "PLC code visualization - graphs, dependencies, and documentation"
66
license = "MIT"

‎plcviz/src/lib.rs‎

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,31 @@
1010
//! - **CallGraph**: Execution flow (Routine → Routine via JSR/AOI calls)
1111
//! - **Combined**: Both structure and calls
1212
//!
13-
//! # Example
13+
//! # CLI Usage
14+
//!
15+
//! ```text
16+
//! plcviz [OPTIONS] <FILE>
17+
//!
18+
//! Arguments:
19+
//! <FILE> L5X file to visualize
20+
//!
21+
//! Options:
22+
//! -t, --type <TYPE> Graph type: structure, call, dataflow, combined [default: structure]
23+
//! -o, --output <FILE> Output file (default: stdout)
24+
//! -h, --help Print help
1425
//! ```
15-
//! use plcviz::L5xGraph;
1626
//!
17-
//! let mut graph = L5xGraph::new();
18-
//! graph.add_program("MainProgram");
19-
//! graph.add_routine("MainProgram", "MainRoutine");
20-
//! graph.add_call("MainRoutine", "SubRoutine");
27+
//! # Examples
28+
//!
29+
//! ```bash
30+
//! # Generate structure graph
31+
//! plcviz project.L5X > graph.svg
32+
//!
33+
//! # Generate call graph
34+
//! plcviz -t call project.L5X > calls.svg
2135
//!
22-
//! let svg = graph.render_svg();
23-
//! assert!(svg.contains("<svg"));
36+
//! # Generate combined graph to file
37+
//! plcviz -t combined -o combined.svg project.L5X
2438
//! ```
2539
2640
pub mod config;

0 commit comments

Comments
 (0)