From 0afd9dc95c16754c97e08c225d0e1ff741107930 Mon Sep 17 00:00:00 2001
From: John Camelon <jcamelon@ca.ibm.com>
Date: Tue, 8 Mar 2005 18:37:33 +0000
Subject: [PATCH] Add JavaDoc.

---
 .../cdt/core/dom/ICodeReaderFactory.java      | 23 +++++++++++++++++++
 .../cdt/core/dom/IParserConfiguration.java    | 11 +++++++++
 2 files changed, 34 insertions(+)

diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ICodeReaderFactory.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ICodeReaderFactory.java
index 015f6789f2a..98f5d7693e7 100644
--- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ICodeReaderFactory.java
+++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ICodeReaderFactory.java
@@ -13,11 +13,34 @@ package org.eclipse.cdt.core.dom;
 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
  */
 public interface ICodeReaderFactory {
     
+
+    /**
+     * @return unique identifier as int
+     */
     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 );
+    
+    
+    /**
+     * Create CodeReader for inclusion.
+     * 
+     * @param path
+     * @return CodeReader for contents at that path.
+     */
     public CodeReader createCodeReaderForInclusion( String path );
 }
diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/IParserConfiguration.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/IParserConfiguration.java
index be75cb5a915..3046881a146 100644
--- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/IParserConfiguration.java
+++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/IParserConfiguration.java
@@ -13,11 +13,22 @@ package org.eclipse.cdt.core.dom;
 import org.eclipse.cdt.core.parser.IScannerInfo;
 
 /**
+ * This interface represents a parser configuration as specified by the 
+ * client to the parser service.  
+ * 
  * @author jcamelon
  */
 public interface IParserConfiguration {
 
+    /**
+     * @return IScannerInfo representing the build information required to parse.
+     */
     public IScannerInfo getScannerInfo();
+    
+    //TODO this may change
+    /**
+     * @return String representing dialect name for the language
+     */
     public String getParserDialect();
 
 }