Improved documentation

Author: bkryza

README.md

@@ -114,8 +114,7 @@ diagrams:
     type: class
     glob:
       - src/*.cc
-    using_namespace:
-      - myproject
+    using_namespace: myproject
     include:
       namespaces:
         - myproject

docs/class_diagrams.md

@@ -29,8 +29,7 @@ diagrams:
     glob:
       - src/*.cc
     # Render all names in the diagram relative to specific namespace
-    using_namespace:
-      - ns1
+    using_namespace: ns1
     # Include only classes from specific namespace
     include:
       namespaces:
@@ -109,7 +108,7 @@ public:
 };
 ```
 
-generates the following diagram:
+results in the following diagram:
 
 ![extension](test_cases/t00007_class.svg)
 

docs/comment_decorators.md

@@ -87,7 +87,7 @@ class R {
 };
 ```
 
-generates the following class diagram:
+results in the following class diagram:
 
 ![note](./test_cases/t00028_class.svg)
 
@@ -141,7 +141,7 @@ struct R {
 };
 ```
 
-generates the following diagram:
+results in the following diagram:
 
 ![skip](./test_cases/t00029_class.svg)
 
@@ -185,7 +185,7 @@ struct R {
 };
 ```
 
-generates the following diagram:
+results in the following diagram:
 
 ![skip](./test_cases/t00030_class.svg)
 
@@ -226,6 +226,6 @@ struct R {
 };
 ```
 
-generates the following diagram:
+results in the following diagram:
 
 ![skip](./test_cases/t00031_class.svg)

docs/common_options.md

@@ -57,7 +57,7 @@ The syntax is simple and based on glob patterns, which can be added to the confi
 
 The glob patterns only need to match the translation units, which are also in the `compile_commands.json` file, i.e.
 any files that match the glob patterns but are not in `compile_commands.json` will be ignored. In case the `glob`
-pattern set does not much any translation units an error will be printed on the standard output.
+pattern set does not match any translation units an error will be printed on the standard output.
 
 For small projects, the `glob` property can be omitted, which will result in `clang-uml` parsing all translation units
 from `compile_commands.json` for the diagram. However for large projects, constraining the number of translation units
@@ -96,13 +96,14 @@ specific diagram element.
 
 ## Resolving include path and compiler flags issues
 Due to the fact, that your project can be compiled with different compilers
-and toolchains than the Clang version, which `clang-uml` uses on your platform,
-include paths specified in the generated `compile_commands.json` can be incorrect.
+and toolchains, the system paths and compilation flags detected by the Clang
+version linked to your `clang-uml` installation might differ from the ones
+actually used to compile your project.
 
 > This is often an issue on macOS, when `clang-uml` uses Homebrew version of LLVM
 > and your project was built using system Apple Clang
 
-Typically, this results in ugly error messages on the screen during diagram
+Typically, this results in error messages on the console during diagram
 generation, such as:
 
 ```
@@ -154,15 +155,15 @@ already as `argv[0]` in your `compile_commands.json`, you can simply invoke
 clang-uml --query-driver .
 ```
 
-however please make sure that the `compile_commands.json` contain a command,
+however please make sure that the `compile_commands.json` contains a command,
 which is safe to execute.
 
 ### Manually add and remove compile flags from the compilation database
 If the system paths extracted from the compiler are not sufficient to resolve
 include paths issues, it is possible to manually adjust the compilation
-flags providing `add_compile_flags` and `remove_compile_flags` in the
+flags by providing `add_compile_flags` and `remove_compile_flags` in the
 configuration file, or providing `--add-compile-flag` and `--remove-compile-flag`
-in the `clang-uml` command line.
+on the `clang-uml` command line.
 
 For instance:
 

docs/diagram_filters.md

@@ -194,8 +194,10 @@ are included based on access scope (e.g. `public`).
 
 ## callee_types
 
-This filter is specific for `sequence diagrams` and allows to control which types calls should be included/excluded from the diagram.
-In a sequence diagram, a `callee` is the receiver of a message, and this filter specifies which types of receivers should match.
+This filter is specific for `sequence diagrams` and allows to control, which
+types of callees should be included/excluded from the diagram. In a sequence diagram,
+a `callee` is the receiver of a message, and this filter specifies which types
+of receivers should match.
 
 The following callee types are supported:
   * constructor
@@ -210,8 +212,9 @@ The following callee types are supported:
 
 ## dependants and dependencies
 
-These filters allow to specify that only dependants or dependencies of a given class should be included in the diagram.
-This can be useful for analyzing what classes in your project depend on some other class, which could have impact for
+These filters allow to specify that only dependants or dependencies of a given
+class should be included in the diagram. This can be useful for analyzing what
+classes in your project depend on some other class, which could have impact for
 instance on refactoring.
 
 For instance the following code:
@@ -283,6 +286,6 @@ and the following filter:
         - dependency
 ```
 
-generates the following diagram:
+results in the following diagram:
 
 ![t00043_class](./test_cases/t00043_class.svg)

docs/diagram_templates.md

@@ -54,7 +54,7 @@ diagram_templates:
 
 ## Adding templates to the configuration file
 Diagram templates can be added directly to the `.clang-uml` configuration file,
-under a `diagram_templates:` key. However, for practical reasons its better
+under a `diagram_templates:` key. However, for practical reasons it is better
 to keep diagram template definitions in a separate Yaml file, and reference
 it in the configuration file using `include!` directive, e.g.: