summaryrefslogtreecommitdiffstats
path: root/src/site-docs/adoc/fragments/howto-codestyle/11-plugin-checkstyle.adoc
diff options
context:
space:
mode:
Diffstat (limited to 'src/site-docs/adoc/fragments/howto-codestyle/11-plugin-checkstyle.adoc')
-rw-r--r--src/site-docs/adoc/fragments/howto-codestyle/11-plugin-checkstyle.adoc26
1 files changed, 26 insertions, 0 deletions
diff --git a/src/site-docs/adoc/fragments/howto-codestyle/11-plugin-checkstyle.adoc b/src/site-docs/adoc/fragments/howto-codestyle/11-plugin-checkstyle.adoc
new file mode 100644
index 000000000..a6a93bfa4
--- /dev/null
+++ b/src/site-docs/adoc/fragments/howto-codestyle/11-plugin-checkstyle.adoc
@@ -0,0 +1,26 @@
+//
+// ============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)
+//
+
+== Eclipse Plugin: Checkstyle
+
+This plugin integrates link:http://checkstyle.sourceforge.net/[Checkstyle] into Eclipse.
+It will check your code and flag any checkstyle issues as warnings in the code.
+
+Available from the Eclipse Marketplace.
+In Eclipse Help->Eclipse Marketplace... and type "Checkstyle".
+Select "Checkstyle Plug-in" when the search returns and install it.
+Note that "Checkstyle Plug-in" may not be the first result in the list of items returned.
+
+You must configure Checkstyle in order to get the most out of it.
+There are two built-in style templates in Checkstyle (from Oracle and Google) but user will almost certainly wish to tweak these.
+