summaryrefslogtreecommitdiffstats
path: root/src/site-docs/adoc/fragments/howto-codestyle
diff options
context:
space:
mode:
Diffstat (limited to 'src/site-docs/adoc/fragments/howto-codestyle')
-rw-r--r--src/site-docs/adoc/fragments/howto-codestyle/01-introduction.adoc5
-rw-r--r--src/site-docs/adoc/fragments/howto-codestyle/11-plugin-checkstyle.adoc6
-rw-r--r--src/site-docs/adoc/fragments/howto-codestyle/30-configure-checkstyle-maven.adoc27
-rw-r--r--src/site-docs/adoc/fragments/howto-codestyle/99-tpl-checkstyle-header.adoc17
-rw-r--r--src/site-docs/adoc/fragments/howto-codestyle/99-tpl-checkstyle-style-checks.adoc17
-rw-r--r--src/site-docs/adoc/fragments/howto-codestyle/99-tpl-eclipse-checkstyle-settings.adoc17
-rw-r--r--src/site-docs/adoc/fragments/howto-codestyle/99-tpl-eclipse-cleanup.adoc17
-rw-r--r--src/site-docs/adoc/fragments/howto-codestyle/99-tpl-eclipse-formatter-profile.adoc17
8 files changed, 9 insertions, 114 deletions
diff --git a/src/site-docs/adoc/fragments/howto-codestyle/01-introduction.adoc b/src/site-docs/adoc/fragments/howto-codestyle/01-introduction.adoc
index 776ad3448..2e8e4fb95 100644
--- a/src/site-docs/adoc/fragments/howto-codestyle/01-introduction.adoc
+++ b/src/site-docs/adoc/fragments/howto-codestyle/01-introduction.adoc
@@ -21,7 +21,6 @@ As long as the style of a particular block of code is understandable, consistent
The JAutoDoc and Checkstyle Eclipse Plugins and tools are useful and remove a lot of the tedium from code documentation.
Use them to check your code and please fix any issues they identify with your code.
-The templates and examples on this page have been tested on a clean installation of Eclipse Oxygen Release (4.7.0) on Ubuntu Linux 16.04 LTS.
-
-The Apex settings referred to on this page are also available in the apex-model GIT repository in the APEX model repository in apex-model/apex-model.build-tools/src/main/resources/`.
+Since APEX is part of ONAP, the general ONAP rules and guideliness for development do apply.
+Please see link:https://wiki.onap.org/display/DW/Developing+ONAP[ONAP Wiki] for details.
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
index a6a93bfa4..d8a55c37e 100644
--- a/src/site-docs/adoc/fragments/howto-codestyle/11-plugin-checkstyle.adoc
+++ b/src/site-docs/adoc/fragments/howto-codestyle/11-plugin-checkstyle.adoc
@@ -21,6 +21,8 @@ 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.
+For APEX, the ONAP checkstyle rules do apply.
+The configuration is part of the ONAP parent.
+See link:https://git.onap.org/oparent/plain/checkstyle/src/main/resources/onap-checkstyle/[ONAP Git] for details and updates.
+All settings for checkstyle are already part of the code (POM files).
diff --git a/src/site-docs/adoc/fragments/howto-codestyle/30-configure-checkstyle-maven.adoc b/src/site-docs/adoc/fragments/howto-codestyle/30-configure-checkstyle-maven.adoc
index 2e6698fff..d59b424af 100644
--- a/src/site-docs/adoc/fragments/howto-codestyle/30-configure-checkstyle-maven.adoc
+++ b/src/site-docs/adoc/fragments/howto-codestyle/30-configure-checkstyle-maven.adoc
@@ -18,28 +18,7 @@ In order not to have to distribute style files for checkstyle into all Maven mod
That module is then used as a dependency in the __POM__ for all other modules that wish to use that checkstyle style.
For a full explanation see link:https://maven.apache.org/plugins/maven-checkstyle-plugin/examples/multi-module-config.html[the explanation of Checkstyle multi-module configuration].
-In Apex, the module `apex-model.build-tools` provides the Apex checkstyle style files as resources in `src/main/resources/checkstyle`.
-This style is a slightly tweaked version of the standard Google checkstyle style that allows longer lines and has some other checks slightly relaxed.
-Therefore, all modules that wish to use the Apex style must put the following build directive into their `pom.xml`.
-
-[source%nowrap,xml]
-----
-<plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-checkstyle-plugin</artifactId>
- <version>2.17</version>
- <dependencies>
- <dependency>
- <groupId>org.onap.policy.apex.model</groupId>
- <artifactId>apex-model.build-tools</artifactId>
- <version>${project.version}</version>
- </dependency>
- </dependencies>
- <configuration>
- <configLocation>checkstyle/apex_style_checks.xml</configLocation>
- <headerLocation>checkstyle/apex_header.txt</headerLocation>
- </configuration>
-</plugin>
-----
-
+For APEX, the ONAP checkstyle rules do apply.
+The configuration is part of the ONAP parent.
+See link:https://git.onap.org/oparent/plain/checkstyle/src/main/resources/onap-checkstyle/[ONAP Git] for details and updates.
diff --git a/src/site-docs/adoc/fragments/howto-codestyle/99-tpl-checkstyle-header.adoc b/src/site-docs/adoc/fragments/howto-codestyle/99-tpl-checkstyle-header.adoc
deleted file mode 100644
index ce6367ef9..000000000
--- a/src/site-docs/adoc/fragments/howto-codestyle/99-tpl-checkstyle-header.adoc
+++ /dev/null
@@ -1,17 +0,0 @@
-//
-// ============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)
-//
-
-[source%nowrap,text,subs="attributes+"]
-----
-include::{apex-main-dir}/checkstyle/apex_header.txt[]
----- \ No newline at end of file
diff --git a/src/site-docs/adoc/fragments/howto-codestyle/99-tpl-checkstyle-style-checks.adoc b/src/site-docs/adoc/fragments/howto-codestyle/99-tpl-checkstyle-style-checks.adoc
deleted file mode 100644
index f67a01c0a..000000000
--- a/src/site-docs/adoc/fragments/howto-codestyle/99-tpl-checkstyle-style-checks.adoc
+++ /dev/null
@@ -1,17 +0,0 @@
-//
-// ============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)
-//
-
-[source%nowrap,xml,subs="attributes+"]
-----
-include::{apex-main-dir}/checkstyle/apex_style_checks.xml[]
----- \ No newline at end of file
diff --git a/src/site-docs/adoc/fragments/howto-codestyle/99-tpl-eclipse-checkstyle-settings.adoc b/src/site-docs/adoc/fragments/howto-codestyle/99-tpl-eclipse-checkstyle-settings.adoc
deleted file mode 100644
index 255855b43..000000000
--- a/src/site-docs/adoc/fragments/howto-codestyle/99-tpl-eclipse-checkstyle-settings.adoc
+++ /dev/null
@@ -1,17 +0,0 @@
-//
-// ============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)
-//
-
-[source%nowrap,xml,subs="attributes+"]
-----
-include::{apex-main-dir}/eclipse/ApexCheckstyleSettings.xml[]
----- \ No newline at end of file
diff --git a/src/site-docs/adoc/fragments/howto-codestyle/99-tpl-eclipse-cleanup.adoc b/src/site-docs/adoc/fragments/howto-codestyle/99-tpl-eclipse-cleanup.adoc
deleted file mode 100644
index 638d33972..000000000
--- a/src/site-docs/adoc/fragments/howto-codestyle/99-tpl-eclipse-cleanup.adoc
+++ /dev/null
@@ -1,17 +0,0 @@
-//
-// ============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)
-//
-
-[source%nowrap,xml,subs="attributes+"]
-----
-include::{apex-main-dir}/eclipse/ApexCleanUpTemplate.xml[]
----- \ No newline at end of file
diff --git a/src/site-docs/adoc/fragments/howto-codestyle/99-tpl-eclipse-formatter-profile.adoc b/src/site-docs/adoc/fragments/howto-codestyle/99-tpl-eclipse-formatter-profile.adoc
deleted file mode 100644
index dad270110..000000000
--- a/src/site-docs/adoc/fragments/howto-codestyle/99-tpl-eclipse-formatter-profile.adoc
+++ /dev/null
@@ -1,17 +0,0 @@
-//
-// ============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)
-//
-
-[source%nowrap,xml,subs="attributes+"]
-----
-include::{apex-main-dir}/eclipse/ApexFormatterProfile.xml[]
----- \ No newline at end of file