| 1 |
KWStyle |
| 2 |
======= |
| 3 |
|
| 4 |
[](https://circleci.com/gh/Kitware/KWStyle ) |
| 5 |
|
| 6 |
Overview |
| 7 |
-------- |
| 8 |
|
| 9 |
KWStyle is a style checker for source code which is integrated in the software process |
| 10 |
to ensure that the code written by several users is consistent and can be |
| 11 |
viewed/printed as it was written by one person. |
| 12 |
|
| 13 |
Features |
| 14 |
-------- |
| 15 |
|
| 16 |
Among the fearures provided by KWStyle: |
| 17 |
|
| 18 |
- Several Indentation checking |
| 19 |
- Copyright Header correctness |
| 20 |
- Maximum line length |
| 21 |
- Encapsulation preservation |
| 22 |
- Internal variable checking via regular expressions |
| 23 |
- New line at the end of file |
| 24 |
|
| 25 |
A complete list of the features is available [here][fl]. |
| 26 |
|
| 27 |
Build |
| 28 |
----- |
| 29 |
|
| 30 |
```shell |
| 31 |
mkdir build |
| 32 |
cd build |
| 33 |
cmake .. |
| 34 |
make |
| 35 |
``` |
| 36 |
|
| 37 |
Install |
| 38 |
------- |
| 39 |
|
| 40 |
- Build and `make install` or `checkinstall` |
| 41 |
- On at least Debian and Trisquel, `apt-get install kwstyle` |
| 42 |
|
| 43 |
|
| 44 |
[fl]: https://kitware.github.io/KWStyle/resources/features.html |