mirror of
https://github.com/eclipse-cdt/cdt
synced 2025-08-05 07:15:39 +02:00
Add JavaDoc.
This commit is contained in:
parent
34ca6299e3
commit
0afd9dc95c
2 changed files with 34 additions and 0 deletions
|
@ -13,11 +13,34 @@ package org.eclipse.cdt.core.dom;
|
||||||
import org.eclipse.cdt.core.parser.CodeReader;
|
import org.eclipse.cdt.core.parser.CodeReader;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* This is the interface that an AST Service uses to delegate the construction
|
||||||
|
* of a CodeReader.
|
||||||
|
*
|
||||||
* @author jcamelon
|
* @author jcamelon
|
||||||
*/
|
*/
|
||||||
public interface ICodeReaderFactory {
|
public interface ICodeReaderFactory {
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return unique identifier as int
|
||||||
|
*/
|
||||||
public int getUniqueIdentifier();
|
public int getUniqueIdentifier();
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create CodeReader for translation unit
|
||||||
|
*
|
||||||
|
* @param path Canonical Path representing path location for file to be opened
|
||||||
|
* @return CodeReader for contents at that path.
|
||||||
|
*/
|
||||||
public CodeReader createCodeReaderForTranslationUnit( String path );
|
public CodeReader createCodeReaderForTranslationUnit( String path );
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create CodeReader for inclusion.
|
||||||
|
*
|
||||||
|
* @param path
|
||||||
|
* @return CodeReader for contents at that path.
|
||||||
|
*/
|
||||||
public CodeReader createCodeReaderForInclusion( String path );
|
public CodeReader createCodeReaderForInclusion( String path );
|
||||||
}
|
}
|
||||||
|
|
|
@ -13,11 +13,22 @@ package org.eclipse.cdt.core.dom;
|
||||||
import org.eclipse.cdt.core.parser.IScannerInfo;
|
import org.eclipse.cdt.core.parser.IScannerInfo;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* This interface represents a parser configuration as specified by the
|
||||||
|
* client to the parser service.
|
||||||
|
*
|
||||||
* @author jcamelon
|
* @author jcamelon
|
||||||
*/
|
*/
|
||||||
public interface IParserConfiguration {
|
public interface IParserConfiguration {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return IScannerInfo representing the build information required to parse.
|
||||||
|
*/
|
||||||
public IScannerInfo getScannerInfo();
|
public IScannerInfo getScannerInfo();
|
||||||
|
|
||||||
|
//TODO this may change
|
||||||
|
/**
|
||||||
|
* @return String representing dialect name for the language
|
||||||
|
*/
|
||||||
public String getParserDialect();
|
public String getParserDialect();
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
Loading…
Add table
Reference in a new issue