From af74a6270d6ab6badf04a97495a6ef8ccded9b4b Mon Sep 17 00:00:00 2001 From: ramverma Date: Tue, 31 Jul 2018 18:25:39 +0100 Subject: 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 --- .../developer-guide/build/dg-build-checkstyle.adoc | 14 ++++++++++++++ .../developer-guide/build/dg-build-documentation.adoc | 14 ++++++++++++++ .../asciidoc/developer-guide/build/dg-build-site.adoc | 14 ++++++++++++++ .../developer-guide/build/dg-build-standard.adoc | 14 ++++++++++++++ .../build/dg-build-with-all-components.adoc | 14 ++++++++++++++ .../developer-guide/build/dg-build-with-all-tests.adoc | 14 ++++++++++++++ .../developer-guide/build/dg-build-with-tests.adoc | 14 ++++++++++++++ src/site/asciidoc/developer-guide/build/dg-build.adoc | 14 ++++++++++++++ .../codestyle/dg-codestyle-02-rules.adoc | 14 ++++++++++++++ .../codestyle/dg-codestyle-10-plugin-jautodoc.adoc | 14 ++++++++++++++ .../codestyle/dg-codestyle-11-plugin-checkstyle.adoc | 14 ++++++++++++++ .../dg-codestyle-20-configure-eclipse-templates.adoc | 14 ++++++++++++++ .../dg-codestyle-21-configure-jautodoc-templates.adoc | 14 ++++++++++++++ .../dg-codestyle-30-configure-checkstyle-maven.adoc | 14 ++++++++++++++ .../dg-codestyle-31-run-checkstyle-maven.adoc | 14 ++++++++++++++ .../dg-codestyle-32-configure-checkstyle-eclipse.adoc | 14 ++++++++++++++ ...dg-codestyle-33-configure-checkstyle-blueprint.adoc | 14 ++++++++++++++ .../dg-codestyle-40-use-eclipse-source-operations.adoc | 14 ++++++++++++++ .../codestyle/dg-codestyle-41-using-jautodoc.adoc | 14 ++++++++++++++ .../codestyle/dg-codestyle-42-using-checkstyle.adoc | 14 ++++++++++++++ .../dg-codestyle-50-disable-eclispe-formatting.adoc | 14 ++++++++++++++ .../codestyle/dg-codestyle-51-supress-checkstyle.adoc | 14 ++++++++++++++ .../developer-guide/codestyle/dg-codestyle.adoc | 14 ++++++++++++++ .../asciidoc/developer-guide/dg-code-examples.adoc | 18 ++++++++++++++++++ 24 files changed, 340 insertions(+) create mode 100644 src/site/asciidoc/developer-guide/build/dg-build-checkstyle.adoc create mode 100644 src/site/asciidoc/developer-guide/build/dg-build-documentation.adoc create mode 100644 src/site/asciidoc/developer-guide/build/dg-build-site.adoc create mode 100644 src/site/asciidoc/developer-guide/build/dg-build-standard.adoc create mode 100644 src/site/asciidoc/developer-guide/build/dg-build-with-all-components.adoc create mode 100644 src/site/asciidoc/developer-guide/build/dg-build-with-all-tests.adoc create mode 100644 src/site/asciidoc/developer-guide/build/dg-build-with-tests.adoc create mode 100644 src/site/asciidoc/developer-guide/build/dg-build.adoc create mode 100644 src/site/asciidoc/developer-guide/codestyle/dg-codestyle-02-rules.adoc create mode 100644 src/site/asciidoc/developer-guide/codestyle/dg-codestyle-10-plugin-jautodoc.adoc create mode 100644 src/site/asciidoc/developer-guide/codestyle/dg-codestyle-11-plugin-checkstyle.adoc create mode 100644 src/site/asciidoc/developer-guide/codestyle/dg-codestyle-20-configure-eclipse-templates.adoc create mode 100644 src/site/asciidoc/developer-guide/codestyle/dg-codestyle-21-configure-jautodoc-templates.adoc create mode 100644 src/site/asciidoc/developer-guide/codestyle/dg-codestyle-30-configure-checkstyle-maven.adoc create mode 100644 src/site/asciidoc/developer-guide/codestyle/dg-codestyle-31-run-checkstyle-maven.adoc create mode 100644 src/site/asciidoc/developer-guide/codestyle/dg-codestyle-32-configure-checkstyle-eclipse.adoc create mode 100644 src/site/asciidoc/developer-guide/codestyle/dg-codestyle-33-configure-checkstyle-blueprint.adoc create mode 100644 src/site/asciidoc/developer-guide/codestyle/dg-codestyle-40-use-eclipse-source-operations.adoc create mode 100644 src/site/asciidoc/developer-guide/codestyle/dg-codestyle-41-using-jautodoc.adoc create mode 100644 src/site/asciidoc/developer-guide/codestyle/dg-codestyle-42-using-checkstyle.adoc create mode 100644 src/site/asciidoc/developer-guide/codestyle/dg-codestyle-50-disable-eclispe-formatting.adoc create mode 100644 src/site/asciidoc/developer-guide/codestyle/dg-codestyle-51-supress-checkstyle.adoc create mode 100644 src/site/asciidoc/developer-guide/codestyle/dg-codestyle.adoc create mode 100644 src/site/asciidoc/developer-guide/dg-code-examples.adoc (limited to 'src/site/asciidoc/developer-guide') diff --git a/src/site/asciidoc/developer-guide/build/dg-build-checkstyle.adoc b/src/site/asciidoc/developer-guide/build/dg-build-checkstyle.adoc new file mode 100644 index 000000000..9fb2741e5 --- /dev/null +++ b/src/site/asciidoc/developer-guide/build/dg-build-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-build/checkstyle.adoc[] diff --git a/src/site/asciidoc/developer-guide/build/dg-build-documentation.adoc b/src/site/asciidoc/developer-guide/build/dg-build-documentation.adoc new file mode 100644 index 000000000..0a5b3f4b5 --- /dev/null +++ b/src/site/asciidoc/developer-guide/build/dg-build-documentation.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-build/documentation.adoc[] diff --git a/src/site/asciidoc/developer-guide/build/dg-build-site.adoc b/src/site/asciidoc/developer-guide/build/dg-build-site.adoc new file mode 100644 index 000000000..727811cea --- /dev/null +++ b/src/site/asciidoc/developer-guide/build/dg-build-site.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-build/site.adoc[] diff --git a/src/site/asciidoc/developer-guide/build/dg-build-standard.adoc b/src/site/asciidoc/developer-guide/build/dg-build-standard.adoc new file mode 100644 index 000000000..1d08e71ab --- /dev/null +++ b/src/site/asciidoc/developer-guide/build/dg-build-standard.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-build/standard.adoc[] diff --git a/src/site/asciidoc/developer-guide/build/dg-build-with-all-components.adoc b/src/site/asciidoc/developer-guide/build/dg-build-with-all-components.adoc new file mode 100644 index 000000000..57ec22156 --- /dev/null +++ b/src/site/asciidoc/developer-guide/build/dg-build-with-all-components.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-build/with-all-components.adoc[] diff --git a/src/site/asciidoc/developer-guide/build/dg-build-with-all-tests.adoc b/src/site/asciidoc/developer-guide/build/dg-build-with-all-tests.adoc new file mode 100644 index 000000000..1bab557cd --- /dev/null +++ b/src/site/asciidoc/developer-guide/build/dg-build-with-all-tests.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-build/with-all-tests.adoc[] diff --git a/src/site/asciidoc/developer-guide/build/dg-build-with-tests.adoc b/src/site/asciidoc/developer-guide/build/dg-build-with-tests.adoc new file mode 100644 index 000000000..3f11e99b0 --- /dev/null +++ b/src/site/asciidoc/developer-guide/build/dg-build-with-tests.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-build/with-tests.adoc[] diff --git a/src/site/asciidoc/developer-guide/build/dg-build.adoc b/src/site/asciidoc/developer-guide/build/dg-build.adoc new file mode 100644 index 000000000..fcc48e9db --- /dev/null +++ b/src/site/asciidoc/developer-guide/build/dg-build.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-build/introduction.adoc[] 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[] diff --git a/src/site/asciidoc/developer-guide/dg-code-examples.adoc b/src/site/asciidoc/developer-guide/dg-code-examples.adoc new file mode 100644 index 000000000..b14fe02fd --- /dev/null +++ b/src/site/asciidoc/developer-guide/dg-code-examples.adoc @@ -0,0 +1,18 @@ +// +// ============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) +// + +== Code Examples + +- APEX Applications (apex-apps) + ** Utilities: link:../modules/tools/tools-common/example-cli.html[CLI Options and Parser Example] + ** Utilities: link:../modules/tools/tools-common/example-cli-version.html[Autoversion for Applications Example] -- cgit 1.2.3-korg