aboutsummaryrefslogtreecommitdiffstats
path: root/src/site-docs/adoc/fragments/howto-build/checkstyle.adoc
blob: f1a8a003f90415170c13145f313a3857b5e0540f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
//
// ============LICENSE_START=======================================================
//  Copyright (C) 2016-2018 Ericsson. All rights reserved.
// ================================================================================
// This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE
// Full license text at https://creativecommons.org/licenses/by/4.0/legalcode
// 
// SPDX-License-Identifier: CC-BY-4.0
// ============LICENSE_END=========================================================
//
// @author Sven van der Meer (sven.van.der.meer@ericsson.com)
//

== Checkstyle with Maven

The codestyle for all APEX java projects can be checked automatically.
The checks include empty or non-existing Javadocs.
Any checkstyle run should complete without any errors, some warnings are acceptable.

To run checkstyle on an APEX Maven project use:

[source%nowrap,sh]
----
mvn checkstyle:check
----


To run checkstyle on all modules use:

[source%nowrap,sh]
----
mvn checkstyle:checkstyle -DapexAll
----