From 054a1f7bf34fe5630f0ea18530adce5d2db923c4 Mon Sep 17 00:00:00 2001 From: Sergey Prigogin Date: Wed, 27 Feb 2013 19:35:59 -0800 Subject: [PATCH] Javadoc adjustments. --- .../dom/ast/IASTPreprocessorIncludeStatement.java | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorIncludeStatement.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorIncludeStatement.java index 0f7ce9af3f1..998f3ada3ee 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorIncludeStatement.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTPreprocessorIncludeStatement.java @@ -23,16 +23,14 @@ import org.eclipse.cdt.core.parser.ISignificantMacros; */ public interface IASTPreprocessorIncludeStatement extends IASTPreprocessorStatement, IFileNomination { /** - * INCLUDE_NAME 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 true. + * 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 null + * 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 */