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

Clarified Javadocs.

Browse source
This commit is contained in:
Sergey Prigogin 2011-09-14 11:09:35 -07:00
parent 5ce8c11602
commit 1c153dcece
2 changed files with 26 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTIfStatement.java
View file

@ -11,13 +11,12 @@
package org.eclipse.cdt.core.dom.ast; package org.eclipse.cdt.core.dom.ast;
/** /**
* The if statement including the optional else clause. * The 'if' statement including the optional else clause.
* *
* @noextend This interface is not intended to be extended by clients. * @noextend This interface is not intended to be extended by clients.
* @noimplement This interface is not intended to be implemented by clients. * @noimplement This interface is not intended to be implemented by clients.
*/ */
public interface IASTIfStatement extends IASTStatement { public interface IASTIfStatement extends IASTStatement {
/** /**
* <code>CONDITION</code> represents the relationship between an * <code>CONDITION</code> represents the relationship between an
* <code>IASTIfStatement</code> and its nested <code>IASTExpression</code>. * <code>IASTIfStatement</code> and its nested <code>IASTExpression</code>.
@ -40,14 +39,16 @@ public interface IASTIfStatement extends IASTStatement {
public static final ASTNodeProperty ELSE = new ASTNodeProperty("IASTIfStatement.ELSE - IASTStatement (else) for IASTIfStatement"); //$NON-NLS-1$ public static final ASTNodeProperty ELSE = new ASTNodeProperty("IASTIfStatement.ELSE - IASTStatement (else) for IASTIfStatement"); //$NON-NLS-1$
/** /**
* Get the condition in the if statement. * Returns the condition in the if statement.
* *
* @return the condition <code>IASTExpression</code> * @return the condition <code>IASTExpression</code>. May return <code>null</code> if the 'if'
* statement has condition declaration instead of condition expression
* (see {@link org.eclipse.cdt.core.dom.ast.cpp.ICPPASTIfStatement}).
*/ */
public IASTExpression getConditionExpression(); public IASTExpression getConditionExpression();
/** /**
* Set the condition in the if statement. * Sets the condition in the if statement.
* *
* @param condition * @param condition
* <code>IASTExpression</code> * <code>IASTExpression</code>
@ -55,14 +56,14 @@ public interface IASTIfStatement extends IASTStatement {
public void setConditionExpression(IASTExpression condition); public void setConditionExpression(IASTExpression condition);
/** /**
* Get the statement that is executed if the condition is true. * Returns the statement that is executed if the condition is true.
* *
* @return the then clause <code>IASTStatement</code> * @return the then clause <code>IASTStatement</code>
*/ */
public IASTStatement getThenClause(); public IASTStatement getThenClause();
/** /**
* Set the statement that is executed if the condition is true. * Sets the statement that is executed if the condition is true.
* *
* @param thenClause * @param thenClause
* <code>IASTStatement</code> * <code>IASTStatement</code>
@ -70,7 +71,7 @@ public interface IASTIfStatement extends IASTStatement {
public void setThenClause(IASTStatement thenClause); public void setThenClause(IASTStatement thenClause);
/** /**
* Get the statement that is executed if the condition is false. This clause * Returns the statement that is executed if the condition is false. This clause
* is optional and returns null if there is none. * is optional and returns null if there is none.
* *
* @return the else clause or null <code>IASTStatement</code> * @return the else clause or null <code>IASTStatement</code>
@ -78,7 +79,7 @@ public interface IASTIfStatement extends IASTStatement {
public IASTStatement getElseClause(); public IASTStatement getElseClause();
/** /**
* Set the else clause. * Sets the else clause.
* *
* @param elseClause * @param elseClause
* <code>IASTStatement</code> * <code>IASTStatement</code>

15
core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPASTIfStatement.java
View file

@ -15,17 +15,28 @@ import org.eclipse.cdt.core.dom.ast.IASTIfStatement;
import org.eclipse.cdt.core.dom.ast.IScope; import org.eclipse.cdt.core.dom.ast.IScope;
/** /**
* The 'if' statement including the optional else clause.
* *
* @noextend This interface is not intended to be extended by clients. * @noextend This interface is not intended to be extended by clients.
* @noimplement This interface is not intended to be implemented by clients. * @noimplement This interface is not intended to be implemented by clients.
*/ */
public interface ICPPASTIfStatement extends IASTIfStatement { public interface ICPPASTIfStatement extends IASTIfStatement {
/**
* Returns the condition declaration. The condition declaration and the condition expression are
* mutually exclusive.
*
* @return the condition declaration, or <code>null</code> if the 'if' statement doesn't
* have a condition declaration.
*/
public IASTDeclaration getConditionDeclaration(); public IASTDeclaration getConditionDeclaration();
/**
* Sets the condition declaration.
*/
public void setConditionDeclaration(IASTDeclaration d); public void setConditionDeclaration(IASTDeclaration d);
/** /**
* Get the implicit <code>IScope</code> represented by this if statement * Returns the implicit <code>IScope</code> represented by this if statement
* *
* @return <code>IScope</code> * @return <code>IScope</code>
*/ */