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 --- .../howto-codestyle/41-using-jautodoc.adoc | 23 ++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 src/site-docs/adoc/fragments/howto-codestyle/41-using-jautodoc.adoc (limited to 'src/site-docs/adoc/fragments/howto-codestyle/41-using-jautodoc.adoc') diff --git a/src/site-docs/adoc/fragments/howto-codestyle/41-using-jautodoc.adoc b/src/site-docs/adoc/fragments/howto-codestyle/41-using-jautodoc.adoc new file mode 100644 index 000000000..0c3ab0518 --- /dev/null +++ b/src/site-docs/adoc/fragments/howto-codestyle/41-using-jautodoc.adoc @@ -0,0 +1,23 @@ +// +// ============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) +// + +== Using JAutodoc + +Similar to Eclipse Source Operations, JAutodoc operations can be carried out on individual files or on all the files in a package but do not recurse into sub-packages. +The JAutodoc operations are available by selecting a file or package and right clicking on __JAutodoc__: + +. To add a `package-info.java` file to a package, select the package and right-click menu:Jautodoc[Add Package Javadoc] +. To add headers to files select on a file (or on the package to do all files) and right click menu:JAutodoc[Add Header] +. To add JAutodoc stubs to a files, select on a file (or on the package to do all files) and right click menu:JAutodoc[Add Javadoc] + + -- cgit 1.2.3-korg