Attachment 118040 Details for Bug 255345 – Javadoc patch for NamingConventions

[patch] Javadoc patch for NamingConventions

255345_patch.txt (text/plain), 6.99 KB, created by Markus Keller

on 2008-11-17 06:27:51 EST

(hide)

Description:

Filename:

MIME Type:

Creator: Markus Keller

Created: 2008-11-17 06:27:51 EST

Size: 6.99 KB

patch

obsolete

>### Eclipse Workspace Patch 1.0
>#P org.eclipse.jdt.core
>Index: model/org/eclipse/jdt/core/NamingConventions.java
>===================================================================
>RCS file: /cvsroot/eclipse/org.eclipse.jdt.core/model/org/eclipse/jdt/core/NamingConventions.java,v
>retrieving revision 1.39
>diff -u -r1.39 NamingConventions.java
>--- model/org/eclipse/jdt/core/NamingConventions.java	27 Oct 2008 14:20:53 -0000	1.39
>+++ model/org/eclipse/jdt/core/NamingConventions.java	17 Nov 2008 11:26:27 -0000
>@@ -11,6 +11,7 @@
> package org.eclipse.jdt.core;
> 
> import org.eclipse.jdt.core.compiler.CharOperation;
>+
> import org.eclipse.jdt.internal.codeassist.impl.AssistOptions;
> import org.eclipse.jdt.internal.compiler.parser.ScannerHelper;
> import org.eclipse.jdt.internal.core.INamingRequestor;
>@@ -25,18 +26,24 @@
> * The possible options are :
> * <ul>
> * <li> {@link JavaCore#CODEASSIST_FIELD_PREFIXES} : Define the Prefixes for Field Name.</li>
>- * <li> {@link JavaCore#CODEASSIST_STATIC_FIELD_PREFIXES} : Define the Prefixes for Static Field Name.</li>
>- * <li> {@link JavaCore#CODEASSIST_LOCAL_PREFIXES} : Define the Prefixes for Local Variable Name.</li>
>- * <li> {@link JavaCore#CODEASSIST_ARGUMENT_PREFIXES} : Define the Prefixes for Argument Name.</li>
> * <li> {@link JavaCore#CODEASSIST_FIELD_SUFFIXES} : Define the Suffixes for Field Name.</li>
>+ * 
>+ * <li> {@link JavaCore#CODEASSIST_STATIC_FIELD_PREFIXES} : Define the Prefixes for Static Field Name.</li>
> * <li> {@link JavaCore#CODEASSIST_STATIC_FIELD_SUFFIXES} : Define the Suffixes for Static Field Name.</li>
>+ * 
>+ * <li> {@link JavaCore#CODEASSIST_STATIC_FINAL_FIELD_PREFIXES} : Define the Prefixes for Static Final Field Name.</li>
>+ * <li> {@link JavaCore#CODEASSIST_STATIC_FINAL_FIELD_SUFFIXES} : Define the Suffixes for Static Final Field Name.</li>
>+ * 
>+ * <li> {@link JavaCore#CODEASSIST_LOCAL_PREFIXES} : Define the Prefixes for Local Variable Name.</li>
> * <li> {@link JavaCore#CODEASSIST_LOCAL_SUFFIXES} : Define the Suffixes for Local Variable Name.</li>
>+ * 
>+ * <li> {@link JavaCore#CODEASSIST_ARGUMENT_PREFIXES} : Define the Prefixes for Argument Name.</li>
> * <li> {@link JavaCore#CODEASSIST_ARGUMENT_SUFFIXES} : Define the Suffixes for Argument Name.</li>
> * </ul>
> * 
> * 
>- * For a complete description of the configurable options, see <code>getDefaultOptions</code>.
>- * For programmaticaly change these options, see <code>JavaCore#setOptions()</code>.
>+ * For a complete description of the configurable options, see {@link JavaCore#getDefaultOptions()}.
>+ * To programmatically change these options, see {@link JavaCore#setOptions(java.util.Hashtable)}.
> * 
> * 
> * This class provides static methods and constants only.
>@@ -1041,16 +1048,16 @@
> 	 *
> 	 * 
> 	 * The base name is used to compute the variable name.
>-	 * Some different kinds of base name are possible and each kind is associated to a different heuristic to compute variable names. 
>+	 * Some different kinds of base names are possible and each kind is associated to a different heuristic to compute variable names. 
> 	 * The heuristic depends also on the kind of the variable. Each kind of variable is identified by a constant starting with <code>VK_</code>. 
> 	 * When a prefix and a suffix can be added then all combinations of prefix and suffix are suggested.
> 	 * If the name is <code>name</code>, the prefix is <code>pre</code> and the suffix is <code>suf</code> then the suggested names will be
> 	 * <code>prenamesuf</code>, <code>prename</code>, <code>namesuf</code> and <code>name</code>. 
> 	 * 
>-	 * The different kinds of base name are:
>+	 * The different kinds of base names are:
> 	 * <ul>
> 	 * <li>{@link #BK_NAME}: the base name is a Java name and the whole base name is considered to compute the variable names. A prefix and a suffix can be added. 
>-	 * There is an heuristic by variable kind.
>+	 * There is a heuristic by variable kind.
> 	 * <ul>
> 	 * <li>{@link #VK_PARAMETER}, {@link #VK_LOCAL}, {@link #VK_INSTANCE_FIELD} and {@link #VK_STATIC_FIELD}: 
> 	 * In this case the first character will be converted to lower case and the other characters won't be changed. 
>@@ -1060,7 +1067,7 @@
> 	 * If the base name is <code>SimpleName</code> then the suggested name will be <code>SIMPLE_NAME</code>.</li>
> 	 * </ul></li>
> 	 * <li>{@link #BK_TYPE_NAME}: the base name is a Java simple type name (e.g. <code>HashMap</code>) and all the words of the base name are considered to compute the variable names. A prefix and a suffix can be added to these names. 
>-	 * There is an heuristic by variable kind.
>+	 * There is a heuristic by variable kind.
> 	 * <ul>
> 	 * <li>{@link #VK_PARAMETER}, {@link #VK_LOCAL}, {@link #VK_INSTANCE_FIELD} and {@link #VK_STATIC_FIELD}: 
> 	 * In this case a variable name will contain some words of the base name and the first character will be converted to lower case. 
>@@ -1083,17 +1090,17 @@
> 	 * </ul>
> 	 * 
> 	 * 
>-	 * For a complete description of these configurable options, see <code>getDefaultOptions</code>.
>-	 * For programmaticaly change these options, see <code>JavaCore#setOptions()</code>.
>+	 * For a complete description of these configurable options, see {@link JavaCore#getDefaultOptions()}.
>+	 * To programmatically change these options, see {@link JavaCore#setOptions(java.util.Hashtable)} and {@link IJavaProject#setOptions(java.util.Map)}
> 	 * 
> 	 * 
> 	 * Proposed names are sorted by relevance (best proposal first). 
> 	 * The names are proposed in the following order:
> 	 * <ol>
>-	 * <li>Names with prefix and suffix. Longest name are proposed first</li>
>-	 * <li>Names with prefix. Longest name are proposed first</li>
>-	 * <li>Names with suffix. Longest name are proposed first</li>
>-	 * <li>Names without prefix and suffix. Longest name are proposed first</li>
>+	 * <li>Names with prefix and suffix. Longer names are proposed first</li>
>+	 * <li>Names with prefix. Longer names are proposed first</li>
>+	 * <li>Names with suffix. Longer names are proposed first</li>
>+	 * <li>Names without prefix and suffix. Longer names are proposed first</li>
> 	 * </ol>
> 	 * 
> 	 *
>@@ -1104,8 +1111,8 @@
> 	 * @param javaProject project which contains the variable or <code>null</code> to take into account only workspace settings.
> 	 * @param dim variable dimension (0 if the field is not an array).
> 	 * @param excluded a list of names which cannot be suggested (already used names).
>-	 * Can be <code>null</code> if there is no excluded names.
>-	 * @param evaluateDefault if set, the result is guaranteed to contain at least one result. If not, the result can be an empty array. 
>+	 * Can be <code>null</code> if there are no excluded names.
>+	 * @param evaluateDefault if <code>true</code>, the result is guaranteed to contain at least one result. If <code>false</code>, the result can be an empty array.
> 	 * @return String[] an array of names.
> 	 * @see JavaCore#setOptions(java.util.Hashtable)
> 	 * @see JavaCore#getDefaultOptions()

Actions: View | Diff

Attachments on bug 255345: 118040 | 118341