1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-04-29 19:45:01 +02:00

fixed some javadoc warnings

This commit is contained in:
Mike Kucera 2008-04-28 14:17:28 +00:00
parent 237a4df396
commit bc10dd89d8
55 changed files with 11 additions and 103 deletions

View file

@ -20,7 +20,6 @@ public interface IASTASMDeclaration extends IASTDeclaration {
/**
* Get the assembly value.
*
* @return
*/
public String getAssembly();

View file

@ -30,7 +30,6 @@ public interface IASTCaseStatement extends IASTStatement {
/**
* The expression that determines whether this case should be taken.
*
* @return
*/
public IASTExpression getExpression();

View file

@ -94,7 +94,6 @@ public interface IASTCompositeTypeSpecifier extends IASTDeclSpecifier , IASTName
/**
* Get the scope that this interface eludes to in the logical tree.
*
* @return
*/
public IScope getScope();
}

View file

@ -111,8 +111,6 @@ public interface IASTEnumerationSpecifier extends IASTDeclSpecifier, IASTNameOwn
/**
* Get the enum's name.
*
* @return
*/
public IASTName getName();

View file

@ -49,10 +49,9 @@ public interface IASTForStatement extends IASTStatement {
public static final ASTNodeProperty INITIALIZER = new ASTNodeProperty(
"IASTForStatement.INITIALIZER - initializer for IASTForStatement"); //$NON-NLS-1$
/**
* @return
*/
public IASTStatement getInitializerStatement();
/**
* @param statement
*/

View file

@ -43,7 +43,6 @@ public interface IASTFunctionDefinition extends IASTDeclaration {
/**
* Get the decl specifier for the function.
*
* @return
*/
public IASTDeclSpecifier getDeclSpecifier();
@ -57,7 +56,6 @@ public interface IASTFunctionDefinition extends IASTDeclaration {
/**
* Get the declarator for the function.
*
* @return
*/
public IASTFunctionDeclarator getDeclarator();
@ -72,7 +70,6 @@ public interface IASTFunctionDefinition extends IASTDeclaration {
* Get the body of the function. This is usually a compound statement but
* C++ also has a function try block.
*
* @return
*/
public IASTStatement getBody();

View file

@ -34,10 +34,9 @@ public interface IASTLabelStatement extends IASTStatement, IASTNameOwner {
*/
public void setName(IASTName name);
/**
* @return
*/
public IASTStatement getNestedStatement();
/**
* @param s
*/

View file

@ -20,7 +20,6 @@ public interface IASTMacroExpansion extends IASTNodeLocation {
/**
* The macro definition used for the expansion
*
* @return
*/
public IASTPreprocessorMacroDefinition getMacroDefinition();
@ -48,7 +47,6 @@ public interface IASTMacroExpansion extends IASTNodeLocation {
* The source locations for for the macro expansion. These are the locations
* where the expansion in question occurred and was replaced.
*
* @return
* @deprecated use {@link IASTNodeLocation#asFileLocation()}.
*/
@Deprecated

View file

@ -39,7 +39,7 @@ public interface IASTNameOwner {
/**
* Get the role for the name.
*
* @param name <code>IASTName</code>
* @param n <code>IASTName</code>
* @return r_declaration, r_reference or r_unclear.
*/
public int getRoleForName( IASTName n );

View file

@ -21,7 +21,6 @@ public interface IASTPreprocessorPragmaStatement extends
/**
* Returns the pragma message.
* @return
*/
public char[] getMessage();

View file

@ -22,7 +22,6 @@ public interface IASTSimpleDeclSpecifier extends IASTDeclSpecifier {
* refined by qualifiers for signed/unsigned and short/long. The type could
* also be unspecified which usually means int.
*
* @return
*/
public int getType();

View file

@ -229,14 +229,10 @@ public interface IASTTranslationUnit extends IASTNode, IAdaptable {
/**
* @param offset
* @return
*/
public String getContainingFilename(int offset);
/**
* @return
*/
public ParserLanguage getParserLanguage();
/**

View file

@ -20,14 +20,12 @@ package org.eclipse.cdt.core.dom.ast;
public interface IArrayType extends IType {
/**
* get the type that this is an array of
* @return
* @throws DOMException
*/
IType getType() throws DOMException;
/**
* get the expression that represents the size of this array
* @return
* @throws DOMException
*/
IASTExpression getArraySizeExpression() throws DOMException;

View file

@ -24,7 +24,6 @@ public interface IBasicType extends IType {
* then refined by qualifiers for signed/unsigned and short/long.
* The type could also be unspecified which usually means int.
*
* @return
*/
public int getType() throws DOMException;

View file

@ -20,7 +20,6 @@ public interface ICompositeType extends IBinding, IType {
public static final int k_union = IASTCompositeTypeSpecifier.k_union;
/**
* what kind of composite type is this?
* @return
*/
public int getKey() throws DOMException;
@ -36,13 +35,11 @@ public interface ICompositeType extends IBinding, IType {
* or null if there is no such field.
*
* @param name
* @return
*/
public IField findField( String name ) throws DOMException;
/**
* get the IScope object that is associated with this composite type
* @return
* @throws DOMException
*/
public IScope getCompositeScope() throws DOMException;

View file

@ -30,14 +30,12 @@ public interface IFunction extends IBinding {
/**
* Get the function scope
*
* @return
* @throws DOMException if this is a problem binding
*/
public IScope getFunctionScope() throws DOMException;
/**
* Get the IFunctionType for this function
* @return
* @throws DOMException if this is a problem binding
*/
public IFunctionType getType() throws DOMException;
@ -45,7 +43,6 @@ public interface IFunction extends IBinding {
/**
* Does this function have the static storage-class specifier
* similarily for extern, auto, register
* @return
* @throws DOMException
*/
public boolean isStatic() throws DOMException;
@ -55,14 +52,12 @@ public interface IFunction extends IBinding {
/**
* is this function inline
* @return
* @throws DOMException
*/
public boolean isInline() throws DOMException;
/**
* Whether or not this function takes variable arguments
* @return
* @throws DOMException
*/
public boolean takesVarArgs()throws DOMException;

View file

@ -18,9 +18,9 @@ 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;
@ -28,7 +28,6 @@ public interface IFunctionType extends IType {
/**
* 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;

View file

@ -21,7 +21,6 @@ public interface ILabel extends IBinding {
/**
* Returns the label statement for this label.
*
* @return
*/
public IASTLabelStatement getLabelStatement() throws DOMException;

View file

@ -20,21 +20,18 @@ package org.eclipse.cdt.core.dom.ast;
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;

View file

@ -36,19 +36,16 @@ public interface IProblemBinding extends IBinding, IScope, IType {
/**
* get the AST node that this problem was created for
* @return
*/
public IASTNode getASTNode();
/**
* returns the file name this problem occured in if known.
* @return
*/
public String getFileName();
/**
* returns the line number for this problem if known
* @return
*/
public int getLineNumber();
@ -60,35 +57,30 @@ public interface IProblemBinding extends IBinding, IScope, IType {
/**
* Attempt to use a symbol that was not found.
* Require attributes: A_SYMBOL_NAME
* @see #A_SYMBOL_NAME
*/
public final static int SEMANTIC_NAME_NOT_FOUND = 0x001;
/**
* Invalid overload of a particular name.
* Required attributes: A_SYMBOL_NAME
* @see #A_SYMBOL_NAME
*/
public static final int SEMANTIC_INVALID_OVERLOAD = 0x002;
/**
* Invalid using directive.
* Required attributes: A_NAMESPACE_NAME
* @see #A_NAMESPACE_NAME
*/
public static final int SEMANTIC_INVALID_USING = 0x003;
/**
* Ambiguous lookup for given name.
* Required attributes: A_SYMBOL_NAME
* @see #A_SYMBOL_NAME
*/
public static final int SEMANTIC_AMBIGUOUS_LOOKUP = 0x004;
/**
* Invalid type provided
* Required attribugtes: A_TYPE_NAME
* @see #A_TYPE_NAME
*/
public static final int SEMANTIC_INVALID_TYPE = 0x005;

View file

@ -20,21 +20,18 @@ package org.eclipse.cdt.core.dom.ast;
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;

View file

@ -20,7 +20,6 @@ public interface IType extends Cloneable {
/**
* is the given type the same as this type?
* @param type
* @return
*/
public boolean isSameType( IType type );
}

View file

@ -17,8 +17,6 @@ public interface ITypedef extends IBinding, IType {
/**
* Returns the type that this thing is a typedef of
*
* @return
*/
public IType getType() throws DOMException;

View file

@ -24,7 +24,6 @@ public interface IVariable extends IBinding {
/**
* Does this function have the static storage-class specifier
* similarily for extern, auto, register
* @return
* @throws DOMException
*/
public boolean isStatic() throws DOMException;

View file

@ -28,7 +28,6 @@ public interface ICCompositeTypeScope extends ICScope {
* and that matches the given name.
*
* @param name
* @return
* @throws DOMException
*/
public IBinding getBinding(char[] name) throws DOMException;

View file

@ -27,7 +27,6 @@ public interface ICFunctionScope extends ICScope {
* Get the scope representing the function body . returns null if there is
* no function definition
*
* @return
* @throws DOMException
*/
public IScope getBodyScope() throws DOMException;
@ -36,7 +35,6 @@ public interface ICFunctionScope extends ICScope {
* return the ILabel binding in this scope that matches the given name
*
* @param name
* @return
* @throws DOMException
*/
public IBinding getBinding(char[] name) throws DOMException;

View file

@ -24,7 +24,6 @@ public interface ICPointerType extends IPointerType {
/**
* is this a restrict pointer
*
* @return
*/
boolean isRestrict();
}

View file

@ -23,7 +23,6 @@ public interface ICQualifierType extends IQualifierType {
/**
* is this a restrict type
*
* @return
*/
public boolean isRestrict();
}

View file

@ -28,7 +28,6 @@ public interface ICPPASTConversionName extends IASTName {
*
* i.e. getTypeId() on operator int(); would return the IASTTypeId for "int"
*
* @return
*/
public IASTTypeId getTypeId();

View file

@ -23,7 +23,6 @@ public interface ICPPASTFieldReference extends IASTFieldReference {
/**
* Was template keyword used?
*
* @return
*/
public boolean isTemplate();

View file

@ -45,7 +45,6 @@ public interface ICPPASTQualifiedName extends IASTName, IASTNameOwner {
/**
* The last name is often semantically significant.
*
* @return
*/
public IASTName getLastName();
@ -68,7 +67,6 @@ public interface ICPPASTQualifiedName extends IASTName, IASTNameOwner {
* This is used to check if the ICPPASTQualifiedName's last segment is
* an ICPPASTConversionName or an ICPPASTOperatorName.
*
* @return
*/
public boolean isConversionOrOperator();
}

View file

@ -28,7 +28,6 @@ public interface ICPPBase {
* In the case of typedefs, the binding being typedefed will be returned instead of
* the typedef itself.
*
* @return
*/
public IBinding getBaseClass() throws DOMException;
@ -41,7 +40,6 @@ public interface ICPPBase {
/**
* The visibility qualifier applied to the base class.
*
* @return
*/
public int getVisibility() throws DOMException;
@ -54,7 +52,6 @@ public interface ICPPBase {
/**
* Whether this is a virtual base class.
*
* @return
*/
public boolean isVirtual() throws DOMException;

View file

@ -23,7 +23,6 @@ import org.eclipse.cdt.core.dom.ast.IBinding;
public interface ICPPBinding extends IBinding {
/**
* return an array of strings representing the qualified name of this binding
* @return
*/
public String [] getQualifiedName() throws DOMException;
public char [][] getQualifiedNameCharArray() throws DOMException;
@ -32,7 +31,6 @@ public interface ICPPBinding extends IBinding {
* returns true if this binding is qualified wrt the translation unit
* for example, local variables, function parameters and local classes will
* all return false.
* @return
* @throws DOMException
*/
public boolean isGloballyQualified() throws DOMException;

View file

@ -20,7 +20,6 @@ public interface ICPPClassScope extends ICPPScope {
/**
* Get the binding for the class this scope is associated with
*
* @return
*/
ICPPClassType getClassType();
@ -30,7 +29,6 @@ public interface ICPPClassScope extends ICPPScope {
* code. The methods that will be implicitly declared are: the default
* constructor, copy constructor, copy assignment operator, and destructor
*
* @return
*/
public ICPPMethod[] getImplicitMethods();
}

View file

@ -35,14 +35,12 @@ public interface ICPPClassTemplatePartialSpecialization extends ICPPClassTemplat
/**
* get the arguments to this specialization
* @return
*/
public IType [] getArguments() throws DOMException;
/**
* get the ICPPTemplateDefinition which this is a specialization of
* @return
*/
public ICPPClassTemplate getPrimaryClassTemplate() throws DOMException;
}

View file

@ -45,7 +45,6 @@ public interface ICPPClassType extends ICompositeType, ICPPBinding {
* to be ambiguous a IProblemBinding is returned.
*
* @param name
* @return
*/
public IField findField(String name) throws DOMException;
@ -89,7 +88,6 @@ public interface ICPPClassType extends ICompositeType, ICPPBinding {
* for this class. This list includes both declared and implicit
* constructors.
*
* @return
*/
public ICPPConstructor[] getConstructors() throws DOMException;
@ -97,14 +95,12 @@ public interface ICPPClassType extends ICompositeType, ICPPBinding {
* return an array of bindings for those classes/functions declared as
* friends of this class.
*
* @return
* @throws DOMException
*/
public IBinding[] getFriends() throws DOMException;
/**
* return an array of nested classes/structures
* @return
* @throws DOMException
*/
public ICPPClassType [] getNestedClasses() throws DOMException;

View file

@ -23,7 +23,6 @@ public interface ICPPConstructor extends ICPPMethod {
/**
* Whether or not this constructor was declared as explicit
*
* @return
* @throws DOMException
*/
boolean isExplicit() throws DOMException;

View file

@ -25,7 +25,6 @@ public interface ICPPFunction extends IFunction, ICPPBinding {
/**
* does this function have the mutable storage class specifier
* @return
* @throws DOMException
*/
public boolean isMutable() throws DOMException;

View file

@ -25,7 +25,6 @@ public interface ICPPFunctionScope extends ICPPScope {
* Get the scope representing the function body. returns null if there is no
* function definition
*
* @return
* @throws DOMException
*/
public IScope getBodyScope() throws DOMException;

View file

@ -24,13 +24,11 @@ public interface ICPPFunctionType extends IFunctionType {
/**
* returns true for a constant method
* @return
*/
public boolean isConst();
/**
* returns true for a volatile method
* @return
*/
public boolean isVolatile();
}

View file

@ -22,7 +22,6 @@ public interface ICPPMember extends ICPPBinding{
/**
* The visibility.
*
* @return
*/
public int getVisibility() throws DOMException;

View file

@ -20,7 +20,6 @@ public interface ICPPMethod extends ICPPFunction, ICPPMember {
/**
* is this a virtual method
* @return
* @throws DOMException
*/
public boolean isVirtual() throws DOMException;

View file

@ -25,14 +25,12 @@ public interface ICPPNamespace extends ICPPBinding {
/**
* get the scope object associated with this namespace
*
* @return
* @throws DOMException
*/
public ICPPNamespaceScope getNamespaceScope() throws DOMException;
/**
* get an array of the all the bindings declared in this namespace.
* @return
* @throws DOMException
*/
public IBinding [] getMemberBindings() throws DOMException;

View file

@ -24,7 +24,6 @@ public interface ICPPPointerToMemberType extends IPointerType {
/**
* Get the class to whose members this points to
*
* @return
*/
public ICPPClassType getMemberOfClass();
}

View file

@ -21,10 +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;

View file

@ -27,13 +27,11 @@ public interface ICPPTemplateInstance extends ICPPSpecialization {
/**
* get the template that this was instantiated from
* @return
*/
public ICPPTemplateDefinition getTemplateDefinition();
/**
* get the types of the arguments the template was instantiated with.
* @return
*/
public IType[] getArguments();
}

View file

@ -22,7 +22,6 @@ public interface ICPPTemplateNonTypeParameter extends ICPPTemplateParameter,
/**
* The default value for this parameter.
*
* @return
*/
public IASTExpression getDefault();

View file

@ -23,7 +23,6 @@ public interface ICPPTemplateScope extends ICPPScope {
/**
* get the template that this scope represents
* @return
*/
public ICPPTemplateDefinition getTemplateDefinition() throws DOMException;

View file

@ -26,7 +26,6 @@ public interface ICPPTemplateTemplateParameter extends ICPPTemplateParameter, IC
/**
* The default type for this parameter. May be null
*
* @return
*/
public IType getDefault() throws DOMException;
}

View file

@ -21,7 +21,6 @@ public interface ICPPTemplateTypeParameter extends ICPPTemplateParameter, IType
/**
* The default type for this parameter. May be null
*
* @return
*/
public IType getDefault() throws DOMException;

View file

@ -21,11 +21,11 @@ import org.eclipse.cdt.core.dom.ast.IBinding;
* @author aniefer
*/
public interface ICPPUsingDeclaration extends ICPPBinding {
/**
* Return an array of bindings that were declared by this using declaration.
* Each of these bindings delegates to some previously declared binding to which it
* is a reference.
* @return
*/
IBinding[] getDelegates();
}

View file

@ -22,9 +22,9 @@ import org.eclipse.cdt.core.dom.ast.IVariable;
* @author aniefer
*/
public interface ICPPVariable extends IVariable, ICPPBinding {
/**
* does this variable have the mutable storage class specifier
* @return
* @throws DOMException
*/
public boolean isMutable() throws DOMException;

View file

@ -71,9 +71,7 @@ public interface ICASTKnRFunctionDeclarator extends IASTFunctionDeclarator, IAST
/**
* Map declarator to IASTName.
*
* @param name
* <code>IASTName</code>
* @return
* @param name <code>IASTName</code>
*/
public IASTDeclarator getDeclaratorForParameterName(IASTName name);
}

View file

@ -22,8 +22,6 @@ import org.eclipse.cdt.core.dom.ast.IPointerType;
public interface IGPPPointerType extends IPointerType {
/**
* is this a restrict pointer
*
* @return
*/
boolean isRestrict();
}

View file

@ -23,7 +23,6 @@ public interface IGPPQualifierType extends IQualifierType {
/**
* is this a restrict type
*
* @return
*/
public boolean isRestrict();
}