summaryrefslogtreecommitdiffstats
path: root/src/site/asciidoc/developer-guide/codestyle
diff options
context:
space:
mode:
authorramverma <ram.krishna.verma@ericsson.com>2018-07-31 18:25:39 +0100
committerramverma <ram.krishna.verma@ericsson.com>2018-07-31 18:27:31 +0100
commitaf74a6270d6ab6badf04a97495a6ef8ccded9b4b (patch)
tree2c7a536e54207a0870ca2008ce457a64de917ab9 /src/site/asciidoc/developer-guide/codestyle
parent9e318f20f2e64970bf3c2e3a5532c516231a6f8a (diff)
Adding first set of apex-pdp document changes
Adding document changes for auth, context, core, model, services & the main apex-pdp module. Change-Id: Id0d026baa258f1dc6998978f9911f3c4a73b5b3b Issue-ID: POLICY-867 Signed-off-by: ramverma <ram.krishna.verma@ericsson.com>
Diffstat (limited to 'src/site/asciidoc/developer-guide/codestyle')
-rw-r--r--src/site/asciidoc/developer-guide/codestyle/dg-codestyle-02-rules.adoc14
-rw-r--r--src/site/asciidoc/developer-guide/codestyle/dg-codestyle-10-plugin-jautodoc.adoc14
-rw-r--r--src/site/asciidoc/developer-guide/codestyle/dg-codestyle-11-plugin-checkstyle.adoc14
-rw-r--r--src/site/asciidoc/developer-guide/codestyle/dg-codestyle-20-configure-eclipse-templates.adoc14
-rw-r--r--src/site/asciidoc/developer-guide/codestyle/dg-codestyle-21-configure-jautodoc-templates.adoc14
-rw-r--r--src/site/asciidoc/developer-guide/codestyle/dg-codestyle-30-configure-checkstyle-maven.adoc14
-rw-r--r--src/site/asciidoc/developer-guide/codestyle/dg-codestyle-31-run-checkstyle-maven.adoc14
-rw-r--r--src/site/asciidoc/developer-guide/codestyle/dg-codestyle-32-configure-checkstyle-eclipse.adoc14
-rw-r--r--src/site/asciidoc/developer-guide/codestyle/dg-codestyle-33-configure-checkstyle-blueprint.adoc14
-rw-r--r--src/site/asciidoc/developer-guide/codestyle/dg-codestyle-40-use-eclipse-source-operations.adoc14
-rw-r--r--src/site/asciidoc/developer-guide/codestyle/dg-codestyle-41-using-jautodoc.adoc14
-rw-r--r--src/site/asciidoc/developer-guide/codestyle/dg-codestyle-42-using-checkstyle.adoc14
-rw-r--r--src/site/asciidoc/developer-guide/codestyle/dg-codestyle-50-disable-eclispe-formatting.adoc14
-rw-r--r--src/site/asciidoc/developer-guide/codestyle/dg-codestyle-51-supress-checkstyle.adoc14
-rw-r--r--src/site/asciidoc/developer-guide/codestyle/dg-codestyle.adoc14
15 files changed, 210 insertions, 0 deletions
diff --git a/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-02-rules.adoc b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-02-rules.adoc
new file mode 100644
index 000000000..85ee11074
--- /dev/null
+++ b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-02-rules.adoc
@@ -0,0 +1,14 @@
+//
+// ============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)
+//
+
+include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/02-rules.adoc[]
diff --git a/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-10-plugin-jautodoc.adoc b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-10-plugin-jautodoc.adoc
new file mode 100644
index 000000000..2c4f691e0
--- /dev/null
+++ b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-10-plugin-jautodoc.adoc
@@ -0,0 +1,14 @@
+//
+// ============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)
+//
+
+include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/10-plugin-jautodoc.adoc[]
diff --git a/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-11-plugin-checkstyle.adoc b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-11-plugin-checkstyle.adoc
new file mode 100644
index 000000000..2cafd21e0
--- /dev/null
+++ b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-11-plugin-checkstyle.adoc
@@ -0,0 +1,14 @@
+//
+// ============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)
+//
+
+include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/11-plugin-checkstyle.adoc[]
diff --git a/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-20-configure-eclipse-templates.adoc b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-20-configure-eclipse-templates.adoc
new file mode 100644
index 000000000..c6ec70ac7
--- /dev/null
+++ b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-20-configure-eclipse-templates.adoc
@@ -0,0 +1,14 @@
+//
+// ============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)
+//
+
+include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/20-configure-eclipse-templates.adoc[]
diff --git a/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-21-configure-jautodoc-templates.adoc b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-21-configure-jautodoc-templates.adoc
new file mode 100644
index 000000000..b829d0d1f
--- /dev/null
+++ b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-21-configure-jautodoc-templates.adoc
@@ -0,0 +1,14 @@
+//
+// ============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)
+//
+
+include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/21-configure-jautodoc-templates.adoc[]
diff --git a/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-30-configure-checkstyle-maven.adoc b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-30-configure-checkstyle-maven.adoc
new file mode 100644
index 000000000..52dbd2fd8
--- /dev/null
+++ b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-30-configure-checkstyle-maven.adoc
@@ -0,0 +1,14 @@
+//
+// ============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)
+//
+
+include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/30-configure-checkstyle-maven.adoc[]
diff --git a/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-31-run-checkstyle-maven.adoc b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-31-run-checkstyle-maven.adoc
new file mode 100644
index 000000000..0ed5772c8
--- /dev/null
+++ b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-31-run-checkstyle-maven.adoc
@@ -0,0 +1,14 @@
+//
+// ============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)
+//
+
+include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/31-run-checkstyle-maven.adoc[]
diff --git a/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-32-configure-checkstyle-eclipse.adoc b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-32-configure-checkstyle-eclipse.adoc
new file mode 100644
index 000000000..86cf187fa
--- /dev/null
+++ b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-32-configure-checkstyle-eclipse.adoc
@@ -0,0 +1,14 @@
+//
+// ============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)
+//
+
+include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/32-configure-checkstyle-eclipse.adoc[]
diff --git a/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-33-configure-checkstyle-blueprint.adoc b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-33-configure-checkstyle-blueprint.adoc
new file mode 100644
index 000000000..b849963d3
--- /dev/null
+++ b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-33-configure-checkstyle-blueprint.adoc
@@ -0,0 +1,14 @@
+//
+// ============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)
+//
+
+include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/33-configure-checkstyle-blueprint.adoc[]
diff --git a/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-40-use-eclipse-source-operations.adoc b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-40-use-eclipse-source-operations.adoc
new file mode 100644
index 000000000..5bb23b0cb
--- /dev/null
+++ b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-40-use-eclipse-source-operations.adoc
@@ -0,0 +1,14 @@
+//
+// ============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)
+//
+
+include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/40-use-eclipse-source-operations.adoc[]
diff --git a/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-41-using-jautodoc.adoc b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-41-using-jautodoc.adoc
new file mode 100644
index 000000000..1ad1e69bc
--- /dev/null
+++ b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-41-using-jautodoc.adoc
@@ -0,0 +1,14 @@
+//
+// ============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)
+//
+
+include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/41-using-jautodoc.adoc[]
diff --git a/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-42-using-checkstyle.adoc b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-42-using-checkstyle.adoc
new file mode 100644
index 000000000..a22ab99ef
--- /dev/null
+++ b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-42-using-checkstyle.adoc
@@ -0,0 +1,14 @@
+//
+// ============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)
+//
+
+include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/42-using-checkstyle.adoc[]
diff --git a/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-50-disable-eclispe-formatting.adoc b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-50-disable-eclispe-formatting.adoc
new file mode 100644
index 000000000..5320969c0
--- /dev/null
+++ b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-50-disable-eclispe-formatting.adoc
@@ -0,0 +1,14 @@
+//
+// ============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)
+//
+
+include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/50-disable-eclispe-formatting.adoc[]
diff --git a/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-51-supress-checkstyle.adoc b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-51-supress-checkstyle.adoc
new file mode 100644
index 000000000..ec1f1ce1c
--- /dev/null
+++ b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-51-supress-checkstyle.adoc
@@ -0,0 +1,14 @@
+//
+// ============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)
+//
+
+include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/51-supress-checkstyle.adoc[]
diff --git a/src/site/asciidoc/developer-guide/codestyle/dg-codestyle.adoc b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle.adoc
new file mode 100644
index 000000000..eb0d982cf
--- /dev/null
+++ b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle.adoc
@@ -0,0 +1,14 @@
+//
+// ============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)
+//
+
+include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/01-introduction.adoc[]