summaryrefslogtreecommitdiffstats
path: root/src/site-docs/adoc/fragments/howto-codestyle/40-use-eclipse-source-operations.adoc
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-docs/adoc/fragments/howto-codestyle/40-use-eclipse-source-operations.adoc
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-docs/adoc/fragments/howto-codestyle/40-use-eclipse-source-operations.adoc')
-rw-r--r--src/site-docs/adoc/fragments/howto-codestyle/40-use-eclipse-source-operations.adoc48
1 files changed, 48 insertions, 0 deletions
diff --git a/src/site-docs/adoc/fragments/howto-codestyle/40-use-eclipse-source-operations.adoc b/src/site-docs/adoc/fragments/howto-codestyle/40-use-eclipse-source-operations.adoc
new file mode 100644
index 000000000..6ead28a7f
--- /dev/null
+++ b/src/site-docs/adoc/fragments/howto-codestyle/40-use-eclipse-source-operations.adoc
@@ -0,0 +1,48 @@
+//
+// ============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=========================================================
+
+== Use Eclipse Source Operations
+
+Eclipse Source Operations can be carried out on individual files or on all the files in a package but do not recurse into sub-packages.
+They are available as a menu in Eclipse by selecting a file or package and right clicking on __Source__.
+Note that running __Clean Up...__ with the Apex clean up profile will run __Format__ and __Organize Imports__.
+So if you run a clean up on a file or package, you need not run __Format__ or __Organize Imports__.
+
+We recommend you use the following Eclipse Source Operations:
+
+. __Format__ applies the current format definition to the file or all files in a package
+. __Organize Imports__ sorts the imports on each file in standard order
+. __Clean Up__ runs a number of cleaning operations on each file. The Apex clean up template
+ ** Remove `this` qualifier for non static field accesses
+ ** Change non static accesses to static members using declaring type
+ ** Change indirect accesses to static members to direct accesses (accesses through subtypes)
+ ** Convert control statement bodies to block
+ ** Convert `for` loops to enhanced `for` loops
+ ** Add final modifier to private fields
+ ** Add final modifier to local variables
+ ** Remove unused imports
+ ** Remove unused private methods
+ ** Remove unused private constructors
+ ** Remove unused private types
+ ** Remove unused private fields
+ ** Remove unused local variables
+ ** Add missing `@Override` annotations
+ ** Add missing `@Override` annotations to implementations of interface methods
+ ** Add missing `@Deprecated` annotations
+ ** Add missing serial version ID (generated)
+ ** Remove unnecessary casts
+ ** Remove unnecessary `$NON-NLS$` tags
+ ** Organize imports
+ ** Format source code
+ ** Remove trailing white spaces on all lines
+ ** Correct indentation
+ ** Remove redundant type arguments
+ ** Add file header (JAutodoc)
+