ramverma | af74a62 | 2018-07-31 18:25:39 +0100 | [diff] [blame] | 1 | // |
| 2 | // ============LICENSE_START======================================================= |
| 3 | // Copyright (C) 2016-2018 Ericsson. All rights reserved. |
| 4 | // ================================================================================ |
| 5 | // This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE |
| 6 | // Full license text at https://creativecommons.org/licenses/by/4.0/legalcode |
| 7 | // |
| 8 | // SPDX-License-Identifier: CC-BY-4.0 |
| 9 | // ============LICENSE_END========================================================= |
| 10 | // |
| 11 | // @author Sven van der Meer (sven.van.der.meer@ericsson.com) |
| 12 | // |
| 13 | |
| 14 | = APEX Developer Guide |
| 15 | Sven van_der_Meer <sven.van.der.meer@ericsson.com>; Liam Fallon <liam.fallon@ericsson.com>; John Keeney <john.keeney@ericsson.com> |
| 16 | |
| 17 | :revdate: 2017-07-31 |
| 18 | :revremark: for APEX {release-version} |
| 19 | :version-label!: |
| 20 | :description: A short guide to develop inside the APEX system |
| 21 | :keywords: APEX, documentation, development, Java |
| 22 | :experimental: |
| 23 | |
| 24 | Version: {release-version} |
| 25 | |
| 26 | Version Date: {revdate} |
| 27 | |
| 28 | Version Notes: {revremark} |
| 29 | |
| 30 | :pygments-linenums-mode: table |
| 31 | :toc: |
| 32 | :toclevels: 4 |
| 33 | :icons: font |
| 34 | |
| 35 | |
| 36 | == Build APEX from Source |
| 37 | |
| 38 | include::{adsite-main-dir}/site-docs/adoc/fragments/howto-build/introduction.adoc[leveloffset=+1] |
| 39 | |
| 40 | include::{adsite-main-dir}/site-docs/adoc/fragments/howto-build/standard.adoc[leveloffset=+1] |
| 41 | |
| 42 | include::{adsite-main-dir}/site-docs/adoc/fragments/howto-build/checkstyle.adoc[leveloffset=+1] |
| 43 | |
| 44 | include::{adsite-main-dir}/site-docs/adoc/fragments/howto-build/with-tests.adoc[leveloffset=+1] |
| 45 | |
| 46 | include::{adsite-main-dir}/site-docs/adoc/fragments/howto-build/with-all-tests.adoc[leveloffset=+1] |
| 47 | |
| 48 | include::{adsite-main-dir}/site-docs/adoc/fragments/howto-build/with-all-components.adoc[leveloffset=+1] |
| 49 | |
| 50 | include::{adsite-main-dir}/site-docs/adoc/fragments/howto-build/documentation.adoc[leveloffset=+1] |
| 51 | |
| 52 | include::{adsite-main-dir}/site-docs/adoc/fragments/howto-build/site.adoc[leveloffset=+1] |
| 53 | |
| 54 | |
| 55 | == APEX Codestyle |
| 56 | |
| 57 | include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/01-introduction.adoc[leveloffset=+1] |
| 58 | |
| 59 | include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/02-rules.adoc[leveloffset=+1] |
| 60 | |
| 61 | include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/10-plugin-jautodoc.adoc[leveloffset=+1] |
| 62 | |
| 63 | include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/11-plugin-checkstyle.adoc[leveloffset=+1] |
| 64 | |
| 65 | include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/20-configure-eclipse-templates.adoc[leveloffset=+1] |
| 66 | |
| 67 | include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/21-configure-jautodoc-templates.adoc[leveloffset=+1] |
| 68 | |
| 69 | include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/30-configure-checkstyle-maven.adoc[leveloffset=+1] |
| 70 | |
| 71 | include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/31-run-checkstyle-maven.adoc[leveloffset=+1] |
| 72 | |
| 73 | include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/32-configure-checkstyle-eclipse.adoc[leveloffset=+1] |
| 74 | |
| 75 | include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/33-configure-checkstyle-blueprint.adoc[leveloffset=+1] |
| 76 | |
| 77 | include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/40-use-eclipse-source-operations.adoc[leveloffset=+1] |
| 78 | |
| 79 | include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/41-using-jautodoc.adoc[leveloffset=+1] |
| 80 | |
| 81 | include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/42-using-checkstyle.adoc[leveloffset=+1] |
| 82 | |
| 83 | include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/50-disable-eclispe-formatting.adoc[leveloffset=+1] |
| 84 | |
| 85 | include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/51-supress-checkstyle.adoc[leveloffset=+1] |
| 86 | |
| 87 | == apex-apps.utilities |
| 88 | |
| 89 | include::{adsite-tools-common-dir}/site-docs/adoc/fragments/example-cli.adoc[leveloffset=+1] |
| 90 | |
| 91 | include::{adsite-tools-common-dir}/site-docs/adoc/fragments/example-cli-version.adoc[leveloffset=+1] |
| 92 | |