javadoc IBindings and ITypes

22 files changed, 135 insertions, 10 deletions

diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IArrayType.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IArrayType.java
index 0b92721100b..c73ccf59f35 100644
--- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IArrayType.java
+++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IArrayType.java
@@ -18,6 +18,10 @@ package org.eclipse.cdt.core.dom.ast;
  * @author aniefer
  */
 public interface IArrayType extends IType {
-
+    /**
+     * get the type that this is an array of
+     * @return
+     * @throws DOMException
+     */
     IType getType() throws DOMException;
 }
diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IEnumeration.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IEnumeration.java
index d609d2ec637..8c35cbc85dd 100644
--- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IEnumeration.java
+++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IEnumeration.java
@@ -18,5 +18,11 @@ package org.eclipse.cdt.core.dom.ast;
  * @author aniefer
  */
 public interface IEnumeration extends IBinding, IType {
+    
+    /**
+     * returns an array of the IEnumerators declared in this enumeration
+     * @return
+     * @throws DOMException
+     */
     IEnumerator [] getEnumerators() throws DOMException;
 }
diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IEnumerator.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IEnumerator.java
index b32a38e99dd..96858e94e65 100644
--- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IEnumerator.java
+++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IEnumerator.java
@@ -19,7 +19,10 @@ package org.eclipse.cdt.core.dom.ast;
  */
 public interface IEnumerator extends IBinding {
 	/**
-	 * @return the type of the variable
+	 * returns the type of this enumeration.  The type of an enumerator
+	 * is the enumeration in which it is declared.
+	 * 
+	 * @return the type of the enumeration
 	 */
 	public IType getType() throws DOMException;
 }
diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IFunction.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IFunction.java
index 0722b17d601..2a714a80409 100644
--- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IFunction.java
+++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IFunction.java
@@ -20,9 +20,9 @@ package org.eclipse.cdt.core.dom.ast;
 public interface IFunction extends IBinding {
 
 	/**
-	 * This gets the parameters to the function which are IVariables.
+	 * This gets the parameters to the function
 	 * 
-	 * @return List of IParameter
+	 * @return array of IParameter
 	 * @throws DOMException if this is a problem binding
 	 */
 	public IParameter [] getParameters() throws DOMException;
@@ -36,7 +36,7 @@ public interface IFunction extends IBinding {
 	public IScope getFunctionScope() throws DOMException;
 	
 	/**
-	 * 
+	 * Get the IFunctionType for this function
 	 * @return
 	 * @throws DOMException if this is a problem binding
 	 */
diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IFunctionType.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IFunctionType.java
index f431bd5be1d..ddfdd7af930 100644
--- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IFunctionType.java
+++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IFunctionType.java
@@ -18,7 +18,18 @@ package org.eclipse.cdt.core.dom.ast;
  * @author aniefer
  */
 public interface IFunctionType extends IType {
+    /**
+     * get the return type of this function type
+     * @return
+     * @throws DOMException
+     */
     public IType getReturnType() throws DOMException;
     
+    /**
+     * get the adjusted parameter types
+     * ISO C99 6.7.5.3, ISO C++98 8.3.4-3 
+     * @return
+     * @throws DOMException
+     */
     public IType [] getParameterTypes() throws DOMException;
 }
diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IPointerType.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IPointerType.java
index 3ab227dc05f..43f3f75eceb 100644
--- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IPointerType.java
+++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IPointerType.java
@@ -18,7 +18,24 @@ package org.eclipse.cdt.core.dom.ast;
  * @author aniefer
  */
 public interface IPointerType extends IType {
+    /**
+     * get the type that this is a pointer to
+     * @return
+     * @throws DOMException
+     */
     public IType getType() throws DOMException;
+    
+    /**
+     * is this a const pointer
+     * @return
+     * @throws DOMException
+     */
     public boolean isConst() throws DOMException;
+    
+    /** 
+     * is this a volatile pointer
+     * @return
+     * @throws DOMException
+     */
     public boolean isVolatile() throws DOMException;
 }
diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IQualifierType.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IQualifierType.java
index 221cca9dbc2..0f9b5aed735 100644
--- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IQualifierType.java
+++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IQualifierType.java
@@ -18,8 +18,24 @@ package org.eclipse.cdt.core.dom.ast;
  * @author aniefer
  */
 public interface IQualifierType extends IType {
+    /**
+     * is this a const type
+     * @return
+     * @throws DOMException
+     */
     public boolean isConst() throws DOMException;
+    
+    /** 
+     * is this a volatile type
+     * @return
+     * @throws DOMException
+     */
     public boolean isVolatile() throws DOMException;
     
+    /** 
+     * get the type that this is qualifying
+     * @return
+     * @throws DOMException
+     */
     public IType getType() throws DOMException;
 }
diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IVariable.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IVariable.java
index bcc939b3baa..84120544eb0 100644
--- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IVariable.java
+++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IVariable.java
@@ -21,5 +21,10 @@ public interface IVariable extends IBinding {
 	public IType getType() throws DOMException;
 	
 	
+	/**
+	 * whether or not this is a static variable
+	 * @return
+	 * @throws DOMException
+	 */
 	public boolean isStatic() throws DOMException;
 }
diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/c/ICExternalBinding.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/c/ICExternalBinding.java
index d8ac4afba4a..4838ed40f33 100644
--- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/c/ICExternalBinding.java
+++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/c/ICExternalBinding.java
@@ -17,6 +17,10 @@ package org.eclipse.cdt.core.dom.ast.c;
 import org.eclipse.cdt.core.dom.ast.IBinding;
 
 /**
+ * This interface represents a binding for a function or variable that
+ * is assumed to exist in another compilation unit and that would be found
+ * at link time.
+ *  
  * @author aniefer
  */
 public interface ICExternalBinding extends IBinding {
diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/c/ICPointerType.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/c/ICPointerType.java
index 485bb168c1f..fbbe5582dc7 100644
--- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/c/ICPointerType.java
+++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/c/ICPointerType.java
@@ -20,5 +20,10 @@ import org.eclipse.cdt.core.dom.ast.IPointerType;
  * @author aniefer
  */
 public interface ICPointerType extends IPointerType {
+    
+    /**
+     * is this a restrict pointer
+     * @return
+     */
     boolean isRestrict();
 }
diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/c/ICQualifierType.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/c/ICQualifierType.java
index 740bce35b53..67b3c6f5d29 100644
--- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/c/ICQualifierType.java
+++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/c/ICQualifierType.java
@@ -20,5 +20,9 @@ import org.eclipse.cdt.core.dom.ast.IQualifierType;
  * @author aniefer
  */
 public interface ICQualifierType extends IQualifierType {
+    /**
+     * is this a restrict type
+     * @return
+     */
     public boolean isRestrict();
 }
diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPClassType.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPClassType.java
index cb1b96d6ad6..a3221033aba 100644
--- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPClassType.java
+++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPClassType.java
@@ -83,9 +83,17 @@ public interface ICPPClassType extends ICompositeType {
 	public ICPPMethod[] getDeclaredMethods() throws DOMException;
 
     /**
+     * Returns an array of ICPPConstructor objects representing the contructors for this
+     * class.  This list includes both declared and implicit constructors.
      * @return
      */
     public ICPPConstructor[] getConstructors() throws DOMException;
 	
+    /**
+     * return an array of bindings for those classes/functions declared as friends of this
+     * class.
+     * @return
+     * @throws DOMException
+     */
     public IBinding [] getFriends() throws DOMException;
 }
diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPCompositeBinding.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPCompositeBinding.java
index 11772c54fab..4c49b443b6d 100644
--- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPCompositeBinding.java
+++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPCompositeBinding.java
@@ -17,8 +17,16 @@ import org.eclipse.cdt.core.dom.ast.DOMException;
 import org.eclipse.cdt.core.dom.ast.IBinding;
 
 /**
+ * This binding is a container for other bindings.  It is used in instances
+ * where an IASTName refers to more than one binding, for example a using declaration
+ * refering to a set of overloaded functions. 
  * @author aniefer
  */
 public interface ICPPCompositeBinding extends IBinding {
+    /**
+     * get the bindings 
+     * @return
+     * @throws DOMException
+     */
 	IBinding [] getBindings() throws DOMException;
 }
diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPConstructor.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPConstructor.java
index ec7c962e5df..aaf853aa413 100644
--- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPConstructor.java
+++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPConstructor.java
@@ -21,7 +21,7 @@ import org.eclipse.cdt.core.dom.ast.DOMException;
 public interface ICPPConstructor extends ICPPMethod {
 
     /**
-     * 
+     * Whether or not this constructor was declared as explicit
      * @return
      * @throws DOMException
      */
diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPNamespace.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPNamespace.java
index 0a9a6f12d6d..89f1c0117bd 100644
--- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPNamespace.java
+++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPNamespace.java
@@ -17,8 +17,14 @@ import org.eclipse.cdt.core.dom.ast.DOMException;
 import org.eclipse.cdt.core.dom.ast.IBinding;
 
 /**
+ * This interface represents a C++ namespace
  * @author aniefer
  */
 public interface ICPPNamespace extends IBinding {
+    /**
+     * get the scope object associated with this namespace
+     * @return
+     * @throws DOMException
+     */
 	public ICPPNamespaceScope getNamespaceScope() throws DOMException;
 }
diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPPointerToMemberType.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPPointerToMemberType.java
index d0c459cdab9..8c7dcb79cb8 100644
--- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPPointerToMemberType.java
+++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPPointerToMemberType.java
@@ -14,12 +14,16 @@
  */
 package org.eclipse.cdt.core.dom.ast.cpp;
 
-import org.eclipse.cdt.core.dom.ast.IBinding;
 import org.eclipse.cdt.core.dom.ast.IPointerType;
 
 /**
  * @author aniefer
  */
 public interface ICPPPointerToMemberType extends IPointerType {
-    public IBinding getMemberOfClass();
+    
+    /**
+     * Get the class to whose members this points to
+     * @return
+     */
+    public ICPPClassType getMemberOfClass();
 }
diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPReferenceType.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPReferenceType.java
index 62ebe1f38b2..2bd409299d3 100644
--- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPReferenceType.java
+++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPReferenceType.java
@@ -21,5 +21,10 @@ import org.eclipse.cdt.core.dom.ast.IType;
  * @author aniefer
  */
 public interface ICPPReferenceType extends IType {
+    /**
+     * get the type that this is a reference of
+     * @return
+     * @throws DOMException
+     */
     public IType getType() throws DOMException;
 }
diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPTemplateTypeParameter.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPTemplateTypeParameter.java
index e7c2f2a9f05..0846c0bc77b 100644
--- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPTemplateTypeParameter.java
+++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPTemplateTypeParameter.java
@@ -20,7 +20,7 @@ public interface ICPPTemplateTypeParameter extends ICPPTemplateParameter, IType
 
 	/**
 	 * The default type for this parameter.
-	 * 
+	 * May be null
 	 * @return
 	 */
 	public IType getDefault() throws DOMException;
diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/gnu/cpp/IGPPPointerType.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/gnu/cpp/IGPPPointerType.java
index f9d9d47f56a..e49fd771649 100644
--- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/gnu/cpp/IGPPPointerType.java
+++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/gnu/cpp/IGPPPointerType.java
@@ -20,5 +20,9 @@ import org.eclipse.cdt.core.dom.ast.IPointerType;
  * @author aniefer
  */
 public interface IGPPPointerType extends IPointerType {
+    /**
+     * is this a restrict pointer
+     * @return
+     */
     boolean isRestrict();
 }
diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/gnu/cpp/IGPPQualifierType.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/gnu/cpp/IGPPQualifierType.java
index 8717f6cd2aa..9893470abcd 100644
--- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/gnu/cpp/IGPPQualifierType.java
+++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/gnu/cpp/IGPPQualifierType.java
@@ -20,5 +20,9 @@ import org.eclipse.cdt.core.dom.ast.IQualifierType;
  * @author aniefer
  */
 public interface IGPPQualifierType extends IQualifierType {
+    /**
+     * is this a restrict type
+     * @return
+     */
     public boolean isRestrict();
 }
diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/internal/core/dom/parser/ITypeContainer.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/internal/core/dom/parser/ITypeContainer.java
index c4cadb44185..d23e49de771 100644
--- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/internal/core/dom/parser/ITypeContainer.java
+++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/internal/core/dom/parser/ITypeContainer.java
@@ -18,9 +18,20 @@ import org.eclipse.cdt.core.dom.ast.DOMException;
 import org.eclipse.cdt.core.dom.ast.IType;
 
 /**
+ * internal interface representing types that contain other types
  * @author aniefer
  */
 public interface ITypeContainer extends IType{
+    /**
+     * get the type this contains
+     * @return
+     * @throws DOMException
+     */
     IType getType() throws DOMException;
+    
+    /**
+     * set the type this contains
+     * @param type
+     */
     void setType( IType type );
 }
diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/internal/core/dom/parser/cpp/CPPPointerToMemberType.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/internal/core/dom/parser/cpp/CPPPointerToMemberType.java
index 12a8f74f08e..4b31f15ce8e 100644
--- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/internal/core/dom/parser/cpp/CPPPointerToMemberType.java
+++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/internal/core/dom/parser/cpp/CPPPointerToMemberType.java
@@ -60,7 +60,7 @@ public class CPPPointerToMemberType extends CPPPointerType implements
 	/* (non-Javadoc)
 	 * @see org.eclipse.cdt.core.dom.ast.cpp.ICPPPointerToMemberType#getMemberOfClass()
 	 */
-	public IBinding getMemberOfClass() {
+	public ICPPClassType getMemberOfClass() {
 		if( clsType == null ){ 
 			ICPPASTPointerToMember pm = (ICPPASTPointerToMember) operator;
 			IASTName name = pm.getName();