@@ -17,12 +17,11 @@ types and contents of each generated diagram.
1717The diagrams can be generated in [ PlantUML] ( https://plantuml.com ) ,
1818[ MermaidJS] ( https://mermaid.js.org/ ) and JSON formats.
1919
20- ` clang-uml ` currently supports C++ up to version 17 with partial support for C++ 20,
21- as well as C and Objective-C.
20+ ` clang-uml ` currently supports C++ up to version 20, as well as C and Objective-C.
2221
2322Full documentation can be found at [ clang-uml.github.io] ( https://clang-uml.github.io ) .
2423
25- To see what ` clang-uml ` can do, checkout the diagrams generated for unit
24+ To see what ` clang-uml ` can do, check out the diagrams generated for unit
2625test cases [ here] ( ./docs/test_cases.md ) or examples in
2726[ clang-uml-examples] ( https://github.com/bkryza/clang-uml-examples ) repository.
2827
@@ -106,17 +105,18 @@ clang-uml
106105```
107106
108107The output path for diagrams, as well as alternative location of
109- compilation database can be specified in ` .clang-uml ` configuration file.
108+ compilation database can be specified in ` .clang-uml ` configuration file or
109+ through command line parameters.
110110
111- For other options checkout help:
111+ For other options see help:
112112
113113``` bash
114114clang-uml --help
115115```
116116
117117### Configuration file format and examples
118118
119- Configuration files are written in YAML, and provide a list of diagrams
119+ Configuration files are written in YAML, and provide definition of diagrams
120120which should be generated by ` clang-uml ` . Basic example is as follows:
121121
122122``` yaml
@@ -143,7 +143,7 @@ See [here](docs/configuration_file.md) for detailed configuration file reference
143143
144144## Examples
145145
146- To see what ` clang-uml` can do, checkout the test cases documentation [here](./docs/test_cases.md).
146+ To see what ` clang-uml` can do, browse the test cases documentation [here](./docs/test_cases.md).
147147
148148In order to see diagrams for the `clang-uml` itself, based on its own [config](.clang-uml) run
149149the following :
@@ -152,7 +152,7 @@ the following:
152152make clanguml_diagrams
153153` ` `
154154
155- and checkout the SVG diagrams in `docs/diagrams` folder.
155+ and open the SVG diagrams in `docs/diagrams` folder.
156156
157157# ## Class diagrams
158158
@@ -228,7 +228,7 @@ results in the following diagram (via PlantUML):
228228
229229
230230> Open the raw image [here](https://raw.githubusercontent.com/bkryza/clang-uml/master/docs/test_cases/t00014_class.svg),
231- > and checkout the hover tooltips and hyperlinks to classes and methods.
231+ > and check out the hover tooltips and hyperlinks to classes and methods.
232232
233233# ## Sequence diagrams
234234
@@ -366,7 +366,7 @@ results in the following diagram (via PlantUML):
366366# ## Include diagrams
367367
368368> In case you're looking for a simpler tool to visualize and analyze include graphs
369- > checkout my other tool - [clang-include-graph](https://github.com/bkryza/clang-include-graph)
369+ > check out my other tool - [clang-include-graph](https://github.com/bkryza/clang-include-graph)
370370
371371# ### Example
372372
@@ -403,7 +403,7 @@ results in the following diagram (via PlantUML) based on include directives in t
403403
404404# ## Diagram content filtering
405405
406- For typical code bases, generating a single diagram from entire code or even a single namespace can be too big to
406+ For typical code bases, a single diagram generated from an entire code or even a single namespace can be too big to
407407be useful, e.g. as part of documentation. `clang-uml` allows specifying content to be included and excluded from
408408each diagram using simple YAML configuration :
409409
0 commit comments