Documentation update: make all {ObjectTeams tags in this module browsable from Search.

13 files changed, 35 insertions, 36 deletions

diff --git a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/CompletionProposal.java b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/CompletionProposal.java
index 5ea1b5f1b..15e03bf71 100644
--- a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/CompletionProposal.java
+++ b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/CompletionProposal.java
@@ -937,7 +937,7 @@ public class CompletionProposal {
 	 *
 	 * @since 3.1
 	 */
-//{ObjectTeams:
+//{ObjectTeams: include OT completion kinds
 /* orig:
 	protected static final int LAST_KIND = ANONYMOUS_CLASS_CONSTRUCTOR_INVOCATION;
   :giro */
diff --git a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/Flags.java b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/Flags.java
index 9ef2a8e2b..a59b823b6 100644
--- a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/Flags.java
+++ b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/Flags.java
@@ -375,7 +375,7 @@ public final class Flags {
 		return (flags & AccAnnotation) != 0;
 	}
 
-//{ObjectTeams
+//{ObjectTeams: more queries for element kinds:
 	/**
 	 * Returns whether the given integer includes the <code>team</code> modifier.
 	 *
diff --git a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/JavaCore.java b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/JavaCore.java
index 1ea993855..57730b12d 100644
--- a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/JavaCore.java
+++ b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/JavaCore.java
@@ -173,7 +173,7 @@ public final class JavaCore extends Plugin {
 	 * (value <code>"org.eclipse.jdt.core"</code>).
 	 */
 	public static final String PLUGIN_ID = "org.eclipse.jdt.core" ; //$NON-NLS-1$
-//{ObjectTeams:
+//{ObjectTeams: OT-specific IDs
 	public static final String OTDT_PLUGIN_ID = "org.eclipse.objectteams.otdt"; //$NON-NLS-1$
 
 	public static final String OTJ_BUILDER_ID = OTDT_PLUGIN_ID + ".builder.OTJBuilder"; //$NON-NLS-1$
@@ -1258,7 +1258,7 @@ public final class JavaCore extends Plugin {
 	 */
 	public static final String COMPILER_PB_MISSING_JAVADOC_COMMENTS_OVERRIDING = PLUGIN_ID + ".compiler.problem.missingJavadocCommentsOverriding"; //$NON-NLS-1$
 
-//{ObjectTeams:
+//{ObjectTeams: new option: scoped keywords (use stateful scanner?)
 	public static final String COMPILER_OPT_SCOPED_KEYWORDS = OTDT_PLUGIN_ID + ".compiler.option.scoped_keywords"; //$NON-NLS-1$
 // SH}
 
diff --git a/org.eclipse.jdt.core/model/org/eclipse/jdt/internal/compiler/SourceElementNotifier.java b/org.eclipse.jdt.core/model/org/eclipse/jdt/internal/compiler/SourceElementNotifier.java
index 55206f8bb..3bd8ac621 100644
--- a/org.eclipse.jdt.core/model/org/eclipse/jdt/internal/compiler/SourceElementNotifier.java
+++ b/org.eclipse.jdt.core/model/org/eclipse/jdt/internal/compiler/SourceElementNotifier.java
@@ -822,26 +822,25 @@ protected void notifySourceElementRequestor(TypeDeclaration typeDeclaration, boo
 	FieldDeclaration[] fields = typeDeclaration.fields;
 	AbstractMethodDeclaration[] methods = typeDeclaration.methods;
 	TypeDeclaration[] memberTypes = typeDeclaration.memberTypes;
-//{ObjectTeams:
+//{ObjectTeams: treatment for method mappings
 	AbstractMethodMappingDeclaration[] bindings    = typeDeclaration.callinCallouts;
 //ak}
 	int fieldCounter = fields == null ? 0 : fields.length;
 	int methodCounter = methods == null ? 0 : methods.length;
 	int memberTypeCounter = memberTypes == null ? 0 : memberTypes.length;
-//{ObjectTeams:
+//{ObjectTeams: treatment for method mappings
 	int bindingCount = (bindings == null) ? 0 : bindings.length;
 //ak}
 	int fieldIndex = 0;
 	int methodIndex = 0;
 	int memberTypeIndex = 0;
-//ObjectTeams:
+//ObjectTeams: treatment for method mappings
 	int bindingIndex = 0;
 //ak}
 
 	if (notifyTypePresence){
 		char[][] interfaceNames = getInterfaceNames(typeDeclaration);
-//{ObjectTeams:
-	    // construction of baseclass's name
+//{ObjectTeams: construction of baseclass's name
 		char[] baseclassName = null;
 		char[] baseclassAnchor= null;
 		if (typeDeclaration.baseclass != null)
@@ -907,7 +906,7 @@ protected void notifySourceElementRequestor(TypeDeclaration typeDeclaration, boo
 			typeInfo.annotations = typeDeclaration.annotations;
 			typeInfo.extraFlags = ExtraFlags.getExtraFlags(typeDeclaration);
 			typeInfo.node = typeDeclaration;
-//{ObjectTeams: added baseclass reference, external role
+//{ObjectTeams: added baseclass reference, isRoleFile:
 			typeInfo.baseclassName = baseclassName; // yes, interfaces will have a baseclass, too. (Current compiler limitation though).
 			typeInfo.baseclassAnchor = baseclassAnchor;
 			typeInfo.isRoleFile = typeDeclaration.isRoleFile();
@@ -940,7 +939,7 @@ protected void notifySourceElementRequestor(TypeDeclaration typeDeclaration, boo
 	while ((fieldIndex < fieldCounter)
 			|| (memberTypeIndex < memberTypeCounter)
 			|| (methodIndex < methodCounter)
-// {ObjectTeams:
+// {ObjectTeams: treatment for method mappings
 		    || (bindingIndex < bindingCount))
 // orig:
 	{
@@ -974,7 +973,7 @@ protected void notifySourceElementRequestor(TypeDeclaration typeDeclaration, boo
 				nextDeclarationType = 2; // MEMBER
 			}
 		}
-//{ObjectTeams:
+//{ObjectTeams: treatment for method mappings
 		if (bindingIndex < bindingCount)
 		{
 			nextBindingDeclaration = bindings[bindingIndex];
@@ -1011,7 +1010,7 @@ protected void notifySourceElementRequestor(TypeDeclaration typeDeclaration, boo
 					&& CharOperation.equals(IOTConstants.CONFINED, nextMemberDeclaration.name))
 					break;
 				notifySourceElementRequestor(nextMemberDeclaration, true, null, currentPackage);
-//{ObjectTeams:
+//{ObjectTeams: treatment for method mappings
 				break;
             case 3:
             	bindingIndex++;
diff --git a/org.eclipse.jdt.core/model/org/eclipse/jdt/internal/compiler/SourceElementRequestorAdapter.java b/org.eclipse.jdt.core/model/org/eclipse/jdt/internal/compiler/SourceElementRequestorAdapter.java
index c3dc479f2..3bb8ac31f 100644
--- a/org.eclipse.jdt.core/model/org/eclipse/jdt/internal/compiler/SourceElementRequestorAdapter.java
+++ b/org.eclipse.jdt.core/model/org/eclipse/jdt/internal/compiler/SourceElementRequestorAdapter.java
@@ -230,7 +230,7 @@ public class SourceElementRequestorAdapter implements ISourceElementRequestor {
     	// default implementation: do nothing
     }
 //jwl}
-//  {ObjectTeams: default implementation
+//  {ObjectTeams: default implementation for baseReference
     public void acceptBaseReference(char[][] typeName, int sourceStart, int sourceEnd){}
 //    haebor}
 
diff --git a/org.eclipse.jdt.core/model/org/eclipse/jdt/internal/compiler/parser/SourceTypeConverter.java b/org.eclipse.jdt.core/model/org/eclipse/jdt/internal/compiler/parser/SourceTypeConverter.java
index f3c2506dc..f781e16f4 100644
--- a/org.eclipse.jdt.core/model/org/eclipse/jdt/internal/compiler/parser/SourceTypeConverter.java
+++ b/org.eclipse.jdt.core/model/org/eclipse/jdt/internal/compiler/parser/SourceTypeConverter.java
@@ -184,8 +184,8 @@ public class SourceTypeConverter extends TypeConverter {
 				types[i] = convert((SourceType) typeInfo.getHandle(), compilationResult);
 			}
 			this.unit.types = types;
-//{ObjectTeams:
-			this.unit.parseMethodBodies = false; // converted cud has no source to parse from.
+//{ObjectTeams: converted cud has no source to parse from.
+			this.unit.parseMethodBodies = false;
 // SH}
 			return this.unit;
 		} catch (AnonymousMemberFound e) {
@@ -407,7 +407,7 @@ public class SourceTypeConverter extends TypeConverter {
 			method.arguments = new Argument[argumentCount];
 			for (int i = 0; i < argumentCount; i++) {
 				TypeReference typeReference = createTypeReference(argumentTypeSignatures[i], start, end);
-//{ObjectTeams:
+//{ObjectTeams: evaluate flag-set to see if decapsulation is allowed:
 				if (   methodHandle.parameterBaseclassFlags != null
 					&& methodHandle.parameterBaseclassFlags[i])
 				{
diff --git a/org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/ClassFile.java b/org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/ClassFile.java
index 2e7a693da..9efc540f4 100644
--- a/org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/ClassFile.java
+++ b/org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/ClassFile.java
@@ -570,7 +570,7 @@ IType getType(char[] enclosingTypeName) {
 	  else
 // SH}
 		this.binaryType = new BinaryType(this, getTypeName());
-//{ObjectTeams: experimental:
+//{ObjectTeams: register unopened type, so OTModelManager can already use it and trigger opening:
 		// make it known to the OTModelManager (without opening):
 		OTModelManager.getSharedInstance().addUnopenedType(this.binaryType);
 // SH}
diff --git a/org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/CompilationUnitStructureRequestor.java b/org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/CompilationUnitStructureRequestor.java
index 8f5fc788d..edfdb280d 100644
--- a/org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/CompilationUnitStructureRequestor.java
+++ b/org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/CompilationUnitStructureRequestor.java
@@ -105,7 +105,7 @@ public class CompilationUnitStructureRequestor extends ReferenceInfoAdapter impl
 	 */
 	protected Stack handleStack;
 
-//{ObjectTeams: for 'team' modifier:
+//{ObjectTeams: 'team' modifier for package declaration:
 	protected int packageModifiers = 0;
 // SH}
 
@@ -185,7 +185,7 @@ public void acceptPackage(ImportReference importReference) {
 		Object parentInfo = this.infoStack.peek();
 		JavaElement parentHandle= (JavaElement) this.handleStack.peek();
 		PackageDeclaration handle = null;
-//{ObjectTeams:
+//{ObjectTeams: team-package ?
 		this.packageModifiers = importReference.modifiers;
 // SH}
 		if (parentHandle.getElementType() == IJavaElement.COMPILATION_UNIT) {
@@ -385,7 +385,7 @@ public void enterMethod(MethodInfo methodInfo) {
 
 	if (parentHandle.getElementType() == IJavaElement.TYPE) {
 		handle = createMethodHandle(parentHandle, methodInfo);
-//{ObjectTeams: propagate this flag array:
+//{ObjectTeams: propagate this flag array (for decapsulation):
 		handle.parameterBaseclassFlags = methodInfo.parameterBaseclassFlags;
 // SH}
 	}
@@ -1067,8 +1067,8 @@ public void enterCallinMapping(ISourceElementRequestor.CallinInfo callinInfo)
     this.infoStack.push(info);
 }
 //jwl, gbr}
-//{ObjectTeams:
-public void acceptBaseReference(char[][] typeName, int sourceStart, int sourceEnd){}
+//{ObjectTeams: null-impl for baseReference
+public void acceptBaseReference(char[][] typeName, int sourceStart, int sourceEnd){ /* no-op*/ }
 //haebor}
 
 }
diff --git a/org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/JavaModelCache.java b/org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/JavaModelCache.java
index a584ca679..38599dc0a 100644
--- a/org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/JavaModelCache.java
+++ b/org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/JavaModelCache.java
@@ -122,7 +122,7 @@ public Object getInfo(IJavaElement element) {
 		case IJavaElement.COMPILATION_UNIT:
 		case IJavaElement.CLASS_FILE:
 			return this.openableCache.get(element);
-//{ObjectTeams:
+//{ObjectTeams: OT type kinds:
 		case IOTJavaElement.ROLE:
 		case IOTJavaElement.TEAM:
 			element= ((OTType)element).getCorrespondingJavaElement();
@@ -190,7 +190,7 @@ protected Object peekAtInfo(IJavaElement element) {
 		case IJavaElement.COMPILATION_UNIT:
 		case IJavaElement.CLASS_FILE:
 			return this.openableCache.peek(element);
-//{ObjectTeams:
+//{ObjectTeams: OT type kinds
 		case IOTJavaElement.ROLE:
 		case IOTJavaElement.TEAM:
 			element= ((OTType)element).getCorrespondingJavaElement();
diff --git a/org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/SourceTypeElementInfo.java b/org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/SourceTypeElementInfo.java
index b6203aeff..1eddc1175 100644
--- a/org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/SourceTypeElementInfo.java
+++ b/org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/SourceTypeElementInfo.java
@@ -40,7 +40,7 @@ public class SourceTypeElementInfo extends AnnotatableInfo implements ISourceTyp
 	 * fully qualified for source types.
 	 */
 	protected char[] superclassName;
-//{ObjectTeams: addition:
+//{ObjectTeams: addition: baseclass reference
 	/**
 	 * The name of the baseclass for this (role) type, if any. 
 	 * This name is fully qualified for binary types and is NOT
diff --git a/org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/hierarchy/HierarchyResolver.java b/org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/hierarchy/HierarchyResolver.java
index 7df927145..2ee7b80a3 100644
--- a/org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/hierarchy/HierarchyResolver.java
+++ b/org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/hierarchy/HierarchyResolver.java
@@ -599,7 +599,7 @@ private void reportHierarchy(IType focus, TypeDeclaration focusLocalType, Refere
 			} else {
 				// top level or member type
 				char[] fullyQualifiedName = focus.getFullyQualifiedName().toCharArray();
-//{ObjectTeams: fix for TPX-302
+//{ObjectTeams: fix for TPX-302 (role class name mangling)
 				try {
 					// HierarchyResolver resolves all found types, LookupEnvironment (PackageBinding)
 					// caches them. Our FocusType's name might be "plain", though, i.e. without
@@ -687,7 +687,7 @@ private void reportHierarchy(IType focus, TypeDeclaration focusLocalType, Refere
 		this.builder.connect(objectType, this.builder.getHandle(objectType, this.typeBindings[objectIndex]), null, null);
 	}
 }
-//{ObjectTeams: 
+//{ObjectTeams: helper for reporting tsuper types
 private IType getHandle(ReferenceBinding typeBinding) {
 	for (int t = this.typeIndex; t >= 0; t--) {
 		if (this.typeBindings[t] == typeBinding) {
@@ -762,7 +762,7 @@ public void resolve(IGenericType suppliedType) {
 		}
 	} catch (AbortCompilation e) { // ignore this exception for now since it typically means we cannot find java.lang.Object
 	} finally {
-//{ObjectTeams:
+//{ObjectTeams: cleanup
 	    if (dependenciesSetup)
 	        Dependencies.release(this);
 //SH}
@@ -784,7 +784,7 @@ public void resolve(IGenericType suppliedType) {
  * @param monitor
  */
 public void resolve(Openable[] openables, HashSet localTypes, IProgressMonitor monitor) {
-//{ObjectTeams
+//{ObjectTeams: conditional setup
     boolean dependenciesSetup = false;
 //carp}
 	try {
@@ -808,7 +808,7 @@ public void resolve(Openable[] openables, HashSet localTypes, IProgressMonitor m
 
 		// build type bindings
 		Parser parser = new Parser(this.lookupEnvironment.problemReporter, true);
-//{ObjectTeams
+//{ObjectTeams: setup Dependencies
 		Dependencies.setup(this, parser, this.lookupEnvironment, true/*build constructor only*/, true);
 		dependenciesSetup = true;
 //carp}
@@ -945,7 +945,7 @@ public void resolve(Openable[] openables, HashSet localTypes, IProgressMonitor m
 					if (hasLocalType[i]) { // NB: no-op if method bodies have been already parsed
 						if (monitor != null && monitor.isCanceled())
 							throw new OperationCanceledException();
-//{ObjectTeams
+//{ObjectTeams: process via Dependencies
 						Dependencies.ensureState(parsedUnit, ITranslationStates.STATE_METHODS_PARSED);
 /* orig:
 						parser.getMethodBodies(parsedUnit);
@@ -980,7 +980,7 @@ public void resolve(Openable[] openables, HashSet localTypes, IProgressMonitor m
 				if (containsLocalType) {
 					if (monitor != null && monitor.isCanceled())
 						throw new OperationCanceledException();
-//{ObjectTeams
+//{ObjectTeams: process via Dependencies
 // faultInTypes is ensured by Dependencies
 /* orig:
 					parsedUnit.scope.faultInTypes();
@@ -1010,7 +1010,7 @@ public void resolve(Openable[] openables, HashSet localTypes, IProgressMonitor m
 		if (TypeHierarchy.DEBUG)
 			e.printStackTrace();
 	} finally {
-//{ObjectTeams
+//{ObjectTeams: cleanup
 	    if (dependenciesSetup)
 	        Dependencies.release(this);
 //SH}
diff --git a/org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/util/MethodInfo.java b/org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/util/MethodInfo.java
index a23889836..cfa2c3d0c 100644
--- a/org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/util/MethodInfo.java
+++ b/org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/util/MethodInfo.java
@@ -119,7 +119,7 @@ public class MethodInfo extends ClassFileStruct implements IMethodInfo {
 			} else if (equals(attributeName, IAttributeNamesConstants.ANNOTATION_DEFAULT)) {
 				this.attributes[attributesIndex++] = new AnnotationDefaultAttribute(classFileBytes, constantPool, offset + readOffset);
 			} else {
-//{ObjectTeams:
+//{ObjectTeams: OT-specific bytecode attribute
 				if (equals(attributeName, IOTConstants.ROLECLASS_METHOD_MODIFIERS_NAME))
 					this.accessFlags = u2At(classFileBytes, readOffset + 6, offset);
 				// fall through, i.e., store any way.
diff --git a/org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/util/PublicScanner.java b/org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/util/PublicScanner.java
index 7b32fb65d..e27c1f246 100644
--- a/org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/util/PublicScanner.java
+++ b/org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/util/PublicScanner.java
@@ -3027,7 +3027,7 @@ private int internalScanIdentifierOrKeyword(int index, int length, char[] data)
 	switch (data[index]) {
 		case 'a' :
 			switch(length) {
-//{ObjectTeams
+//{ObjectTeams: keyword 'as':
 				case 2: //as
 					if (   this._isOTSource
 						&& (data[++index] == 's')) {