diff options
Diffstat (limited to 'src/site-docs/adoc/fragments/howto-build/checkstyle.adoc')
| -rw-r--r-- | src/site-docs/adoc/fragments/howto-build/checkstyle.adoc | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/src/site-docs/adoc/fragments/howto-build/checkstyle.adoc b/src/site-docs/adoc/fragments/howto-build/checkstyle.adoc new file mode 100644 index 000000000..f1a8a003f --- /dev/null +++ b/src/site-docs/adoc/fragments/howto-build/checkstyle.adoc @@ -0,0 +1,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 +---- + |