Skip to content

Commit ca476ca

Browse files
committed
[docs] Added screenshots to the README
1 parent 483f965 commit ca476ca

File tree

7 files changed

+29
-0
lines changed

7 files changed

+29
-0
lines changed

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,42 @@ More formally the plugin provides:
1717
- alignment of consecutive assignments by the equal sign;
1818
- pretty rich set of alignment settings in `File | Settings | Editor | Inlay Hints | Java | Java Code Aligner`.
1919

20+
Please note, that fields alignment is performed only if its modifiers are placed
21+
in [the canonical order](https://docs.oracle.com/javase/specs/jls/se7/html/jls-8.html#jls-8.3.1).
22+
2023
From the technical side, plugin works by adding invisible inlay hints (like the ones shown as parameter names for method
2124
calls), which can be made visible via `Enable debug mode` in settings above.
2225

2326
Additionally, the plugin provides **folding of explicit types** to `var` and `final var` for local variable
2427
declarations, which can be enabled in `File | Settings | Editor | General | Code Folding | Java Code Aligner`.
2528
<!-- Plugin description end -->
2629

30+
## Screenshots
31+
32+
### Fields alignment:
33+
34+
<img src="docs/fields_demo.png" alt="Fields alignment demo" title="fields alignment demo"/>
35+
36+
### Params alignment:
37+
38+
<img alt="Params alignment" src="docs/params_demo.png" title="Params alignment demo"/>
39+
40+
### Local variables declaration alignment:
41+
42+
<img alt="Local variables declaration alignment demo" src="docs/locals_demo.png" title="Local variables declaration alignment demo"/>
43+
44+
### Local variables declaration with folded types alignment:
45+
46+
<img alt="Local variables declaration with folded types demo" src="docs/local_vars_with_folded_types_demo.png" title="Local variables declaration with folded types demo"/>
47+
48+
### Alignment settings:
49+
50+
<img alt="Alignment settings demo" src="docs/inlay_settings_demo.png" title="Alignment settings demo"/>
51+
52+
### Local variables types folding settings:
53+
54+
<img alt="Local variables types folding settings demo" src="docs/folding_settings_demo.png" title="Local variables types folding settings demo"/>
55+
2756
## Installation
2857

2958
- Using IDE built-in plugin system:

docs/fields_demo.png

134 KB
Loading

docs/folding_settings_demo.png

73.6 KB
Loading

docs/inlay_settings_demo.png

82.5 KB
Loading
264 KB
Loading

docs/locals_demo.png

249 KB
Loading

docs/params_demo.png

182 KB
Loading

0 commit comments

Comments
 (0)