From c27d6dec2961853dbcc39623fd560d30cb13f67c Mon Sep 17 00:00:00 2001 From: Sergey Prigogin Date: Tue, 20 Sep 2011 11:35:44 -0700 Subject: Adjusted Javadoc. --- .../parser/org/eclipse/cdt/core/dom/ast/ICompositeType.java | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/ICompositeType.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/ICompositeType.java index e076c4ebca8..439bf8f9613 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/ICompositeType.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/ICompositeType.java @@ -10,7 +10,6 @@ *******************************************************************************/ package org.eclipse.cdt.core.dom.ast; - /** * Interface for all composite types: classes, structs or unions. * @@ -18,11 +17,12 @@ package org.eclipse.cdt.core.dom.ast; * @noimplement This interface is not intended to be implemented by clients. */ public interface ICompositeType extends IBinding, IType { - public static final int k_struct = IASTCompositeTypeSpecifier.k_struct; public static final int k_union = IASTCompositeTypeSpecifier.k_union; + /** - * what kind of composite type is this? + * Returns the type of the composite, {@link #k_struct}, {@link #k_union}, or + * {@link org.eclipse.cdt.core.dom.ast.cpp.ICPPClassType#k_class}. */ public int getKey(); @@ -46,15 +46,14 @@ public interface ICompositeType extends IBinding, IType { public IField[] getFields(); /** - * returns the field that matches name, - * or null if there is no such field. + * Returns the field that matches name, or null if there is no such field. * * @param name */ public IField findField(String name); /** - * get the IScope object that is associated with this composite type + * Returns the IScope object that is associated with this composite type */ public IScope getCompositeScope(); } -- cgit v1.2.3