mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-04-23 14:42:11 +02:00
Code Issues Wiki Activity

Comment adjustments.

Browse source
This commit is contained in:
Sergey Prigogin 2009-05-24 04:34:37 +00:00
parent fd233c56eb
commit 8ba4659e47
2 changed files with 29 additions and 35 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTTranslationUnit.java
View file

@ -55,7 +55,7 @@ public interface IASTTranslationUnit extends IASTNode, IASTDeclarationListOwner,
public IASTDeclaration[] getDeclarations();
/**
* Add declaration to translation unit.
* Adds declaration to translation unit.
*
* @param declaration <code>IASTDeclaration</code>
*/
@ -137,7 +137,7 @@ public interface IASTTranslationUnit extends IASTNode, IASTDeclarationListOwner,
public IASTNode selectNodeForLocation(String path, int offset, int length);
/**
* Get the macro definitions encountered in parsing this translation unit. The result will not contain
* Returns the macro definitions encountered in parsing this translation unit. The result will not contain
* definitions for built-in macros.
* <p>
* In case the information for a header-file is pulled in from the index,
@ -146,13 +146,13 @@ public interface IASTTranslationUnit extends IASTNode, IASTDeclarationListOwner,
public IASTPreprocessorMacroDefinition[] getMacroDefinitions();
/**
* Get built-in macro definitions used when parsing this translation unit.
* Returns built-in macro definitions used when parsing this translation unit.
* This includes macros obtained from the index.
*/
public IASTPreprocessorMacroDefinition[] getBuiltinMacroDefinitions();
/**
* Get the include directives encountered in parsing this translation unit. This will also contain directives
* Returns the include directives encountered in parsing this translation unit. This will also contain directives
* used for handling the gcc-options -imacros and -include.
* <p>
* In case the information for a header-file is pulled in from the index,
@ -161,7 +161,7 @@ public interface IASTTranslationUnit extends IASTNode, IASTDeclarationListOwner,
public IASTPreprocessorIncludeStatement[] getIncludeDirectives();
/**
* Get all preprocessor statements.
* Returns all preprocessor statements.
* In case the information for a header-file is pulled in from the index,
* preprocessing statements contained therein are not returned.
*/
@ -173,7 +173,7 @@ public interface IASTTranslationUnit extends IASTNode, IASTDeclarationListOwner,
public IASTPreprocessorMacroExpansion[] getMacroExpansions();
/**
* Get all preprocessor and scanner problems.
* Returns all preprocessor and scanner problems.
* @return <code>IASTProblem[]</code>
*/
public IASTProblem[] getPreprocessorProblems();
@ -184,13 +184,13 @@ public interface IASTTranslationUnit extends IASTNode, IASTDeclarationListOwner,
public int getPreprocessorProblemsCount();
/**
* Get the translation unit's full path.
* Returns the translation unit's full path.
* @return String representation of path.
*/
public String getFilePath();
/**
* Flatten the node locations provided into a single file location.
* Flattens the node locations provided into a single file location.
*
* @param nodeLocations <code>IASTNodeLocation</code>s to flatten
* @return null if not possible, otherwise, a file location representing where the macros are.
@ -207,13 +207,10 @@ public interface IASTTranslationUnit extends IASTNode, IASTDeclarationListOwner,
public static final ASTNodeProperty MACRO_EXPANSION = new ASTNodeProperty(
"IASTTranslationUnit.MACRO_EXPANSION - IASTPreprocessorMacroExpansion node for macro expansions."); //$NON-NLS-1$
public static interface IDependencyTree
{
public static interface IDependencyTree {
public String getTranslationUnitPath();
public static interface IASTInclusionNode
{
public static interface IASTInclusionNode {
public IASTPreprocessorIncludeStatement getIncludeDirective();
public IASTInclusionNode[] getNestedInclusions();
}
@ -222,7 +219,7 @@ public interface IASTTranslationUnit extends IASTNode, IASTDeclarationListOwner,
}
/**
* Return the dependency tree for the translation unit.
* Returns the dependency tree for the translation unit.
* <p>
* In case the information for a header-file is pulled in from the index,
* dependencies contained therein are not part of the dependency tree.
@ -234,13 +231,12 @@ public interface IASTTranslationUnit extends IASTNode, IASTDeclarationListOwner,
*/
public String getContainingFilename(int offset);
public ParserLanguage getParserLanguage();
/**
* Return the Index associated with this translation unit.
* Returns the Index associated with this translation unit.
*
* @return the Index for this translation unit
* @return the Index for this translation unit.
*/
public IIndex getIndex();
@ -254,7 +250,7 @@ public interface IASTTranslationUnit extends IASTNode, IASTDeclarationListOwner,
IIndexFileSet getIndexFileSet();
/**
* In case the ast was created in a way that supports comment parsing,
* In case the AST was created in a way that supports comment parsing,
* all comments of the translation unit are returned. Otherwise an
* empty array will be supplied.
*
@ -263,14 +259,13 @@ public interface IASTTranslationUnit extends IASTNode, IASTDeclarationListOwner,
*/
public IASTComment[] getComments();
/**
* Returns the linkage this ast was parsed in
* Returns the linkage this AST was parsed in.
*/
public ILinkage getLinkage();
/**
* Returns whether this ast represents a header file.
* Returns whether this AST represents a header file.
*/
public boolean isHeaderUnit();
@ -283,13 +278,13 @@ public interface IASTTranslationUnit extends IASTNode, IASTDeclarationListOwner,
public INodeFactory getASTNodeFactory();
/**
* Set the Index to be used for this translation unit.
* Sets the Index to be used for this translation unit.
* @noreference This method is not intended to be referenced by clients.
*/
public void setIndex(IIndex index);
/**
* Sets whether this ast represents a header file.
* Sets whether this AST represents a header file.
* @noreference This method is not intended to be referenced by clients.
*/
public void setIsHeaderUnit(boolean headerUnit);
@ -304,7 +299,6 @@ public interface IASTTranslationUnit extends IASTNode, IASTDeclarationListOwner,
*/
public void freeze();
/**
* Returns a copy of the AST, however the ILocationResolver
* and the preprocessor nodes are not copied.