1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-08-08 08:45:44 +02:00

Javadoc adjustments.

This commit is contained in:
Sergey Prigogin 2013-03-14 17:17:27 -07:00
parent 6a55086327
commit 8691f9784c
5 changed files with 18 additions and 17 deletions

View file

@ -37,25 +37,25 @@ public interface IASTFileLocation extends IASTNodeLocation {
public int getNodeLength(); public int getNodeLength();
/** /**
* Get the starting line number. Locations obtained via the index do not have line numbers * Returns the starting line number. Locations obtained via the index do not have line numbers
* and return <code>0</code>. * and return {@code 0}.
* *
* @return int representing line number or <code>0</code> if not applicable * @return the 1-based line number, or {@code 0} if not applicable
*/ */
public int getStartingLineNumber(); public int getStartingLineNumber();
/** /**
* Get the ending line number. Locations obtained via the index do not have line numbers * Returns the ending line number. Locations obtained via the index do not have line numbers
* and return <code>0</code>. * and return {@code 0}.
* *
* @return int representing line number or <code>0</code> if not applicable * @return the 1-based line number, or {@code 0} if not applicable
*/ */
public int getEndingLineNumber(); public int getEndingLineNumber();
/** /**
* Returns the inclusion statement that included this file, or <code>null</code> for * Returns the inclusion statement that included this file, or <code>null</code> for
* a top-level file. * a top-level file.
* Also <code>null</code> when the file location does not belong to an AST node, e.g. * Also {@code null} when the file location does not belong to an AST node, e.g.
* if it is obtained from a name in the index. * if it is obtained from a name in the index.
* @since 5.4 * @since 5.4
*/ */

View file

@ -11,8 +11,8 @@
package org.eclipse.cdt.core.dom.ast; package org.eclipse.cdt.core.dom.ast;
/** /**
* The for statement. The initialization clause can be an expression or a * The 'for' statement. The initialization clause can be an expression
* declaration but not both. * or a declaration but not both.
* *
* @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.
@ -57,8 +57,7 @@ public interface IASTForStatement extends IASTStatement {
* @param statement * @param statement
*/ */
public void setInitializerStatement( IASTStatement statement ); public void setInitializerStatement( IASTStatement statement );
/** /**
* Get the condition expression for the loop. * Get the condition expression for the loop.
* *

View file

@ -32,7 +32,7 @@ public interface IASTIdExpression extends IASTExpression, IASTNameOwner {
public IASTName getName(); public IASTName getName();
/** /**
* Set the name to be used inthe expression. * Sets the name to be used in the expression.
* *
* @param name * @param name
*/ */

View file

@ -15,14 +15,16 @@ import org.eclipse.cdt.core.dom.ast.IASTDeclaration;
import org.eclipse.cdt.core.dom.ast.IASTForStatement; import org.eclipse.cdt.core.dom.ast.IASTForStatement;
/** /**
* * The C++ 'for' statement.
*
* @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 ICPPASTForStatement extends IASTForStatement { public interface ICPPASTForStatement extends IASTForStatement {
public static final ASTNodeProperty CONDITION_DECLARATION =
public static final ASTNodeProperty CONDITION_DECLARATION = new ASTNodeProperty( "org.eclipse.cdt.core.dom.ast.cpp.ICPPASTForStatement"); //$NON-NLS-1$ new ASTNodeProperty("org.eclipse.cdt.core.dom.ast.cpp.ICPPASTForStatement"); //$NON-NLS-1$
public void setConditionDeclaration( IASTDeclaration d );
public void setConditionDeclaration(IASTDeclaration d);
public IASTDeclaration getConditionDeclaration(); public IASTDeclaration getConditionDeclaration();
/** /**

View file

@ -28,7 +28,7 @@ public interface ICPPEnumeration extends IEnumeration, ICPPBinding {
boolean isScoped(); boolean isScoped();
/** /**
* Returns the underlying type of the enumeration if it is fixed, or <code>null</code> otherwise. * Returns the underlying type of the enumeration if it is fixed, or {@code null} otherwise.
* The underlying type can only be fixed in C++. * The underlying type can only be fixed in C++.
*/ */
IType getFixedType(); IType getFixedType();