Skip to content

Commit

Permalink
Update docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
simonbrowndotje committed Sep 19, 2024
1 parent a52e8f9 commit be69af2
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
2 changes: 1 addition & 1 deletion changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
- structurizr-dsl: Adds an `!elements` keyword that can be used to find a set of elements via an expression.
- structurizr-dsl: Adds an `!relationship` keyword that can be used to find a single relationship by identifier (replaces `!ref` and `!extend`).
- structurizr-dsl: Adds a `!relationships` keyword that can be used to find a set of relationships via an expression.
- structurizr-dsl: Adds a DSL wrapper around the `structurizr-component` component finder.
- structurizr-dsl: Adds a DSL wrapper around the `structurizr-component` component finder (`!components`).
- structurizr-dsl: Adds support for local theme files to be specified via `theme` (https://github.com/structurizr/java/issues/331).
- structurizr-dsl: An exception is now thrown when trying to use disallowed features in restricted mode (e.g. `!docs`, `!include <file>`, etc).
- structurizr-export: Adds support for icons to the Ilograph exporter (https://github.com/structurizr/java/issues/332).
Expand Down
6 changes: 5 additions & 1 deletion structurizr-component/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,9 @@
This library provides a facility to discover components in a Java codebase, via a combination of
[Apache Commons BCEL](https://commons.apache.org/proper/commons-bcel/) and [JavaParser](https://javaparser.org),
using a pluggable and customisable set of matching and filtering rules.
It is also available via the Structurizr DSL `!component` keyword.

__Unreleased, experimental, and potentially subject to change - see tests for an example.__
See the following tests for an example:

- https://github.com/structurizr/java/blob/master/structurizr-component/src/test/java/com/structurizr/component/SpringPetClinicTests.java
- https://github.com/structurizr/java/blob/master/structurizr-dsl/src/test/resources/dsl/spring-petclinic/workspace.dsl

0 comments on commit be69af2

Please sign in to comment.