| ramverma | af74a62 | 2018-07-31 18:25:39 +0100 | [diff] [blame^] | 1 | // |
| 2 | // ============LICENSE_START======================================================= |
| 3 | // Copyright (C) 2016-2018 Ericsson. All rights reserved. |
| 4 | // ================================================================================ |
| 5 | // This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE |
| 6 | // Full license text at https://creativecommons.org/licenses/by/4.0/legalcode |
| 7 | // |
| 8 | // SPDX-License-Identifier: CC-BY-4.0 |
| 9 | // ============LICENSE_END========================================================= |
| 10 | // |
| 11 | // @author Sven van der Meer (sven.van.der.meer@ericsson.com) |
| 12 | // |
| 13 | |
| 14 | == Checkstyle with Maven |
| 15 | |
| 16 | The codestyle for all APEX java projects can be checked automatically. |
| 17 | The checks include empty or non-existing Javadocs. |
| 18 | Any checkstyle run should complete without any errors, some warnings are acceptable. |
| 19 | |
| 20 | To run checkstyle on an APEX Maven project use: |
| 21 | |
| 22 | [source%nowrap,sh] |
| 23 | ---- |
| 24 | mvn checkstyle:check |
| 25 | ---- |
| 26 | |
| 27 | |
| 28 | To run checkstyle on all modules use: |
| 29 | |
| 30 | [source%nowrap,sh] |
| 31 | ---- |
| 32 | mvn checkstyle:checkstyle -DapexAll |
| 33 | ---- |
| 34 | |