1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-07-23 17:05:26 +02:00

Javadoc adjustments.

This commit is contained in:
Sergey Prigogin 2013-02-27 19:35:59 -08:00
parent 470b57572c
commit 054a1f7bf3

View file

@ -23,16 +23,14 @@ import org.eclipse.cdt.core.parser.ISignificantMacros;
*/
public interface IASTPreprocessorIncludeStatement extends IASTPreprocessorStatement, IFileNomination {
/**
* <code>INCLUDE_NAME</code> describes the relationship between an include directive and
* it's name.
* {@code INCLUDE_NAME} describes the relationship between an include directive and its name.
*/
public static final ASTNodeProperty INCLUDE_NAME = new ASTNodeProperty(
"IASTPreprocessorMacroDefinition.INCLUDE_NAME - Include Name"); //$NON-NLS-1$
/**
* Returns the absolute location of the file found through #include.
* Only valid if {@link #isResolved()} returns <code>true</code>.
* Returns the absolute location of the file found through #include, or an empty string if
* include was not resolved.
*/
public String getPath();
@ -109,14 +107,14 @@ public interface IASTPreprocessorIncludeStatement extends IASTPreprocessorStatem
public boolean isErrorInIncludedFile();
/**
* Returns true, if an attempt will be or has been made to create AST for the target
* Returns {@code true}, if an attempt will be or has been made to create AST for the target
* of this inclusion.
* @since 5.4
*/
public boolean createsAST();
/**
* Returns the file from the index that this include statement has pulled in, or <code>null</code>
* Returns the file from the index that this include statement has pulled in, or {@code null}
* if the include creates AST or is unresolved or skipped.
* @since 5.4
*/