mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-08-09 01:05:38 +02:00
Code Issues Wiki Activity

Javadoc adjustments.

Browse source
This commit is contained in:
Sergey Prigogin 2013-02-27 19:35:59 -08:00
parent 470b57572c
commit 054a1f7bf3
1 changed files with 5 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorIncludeStatement.java
View file

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