Added documentation

dgaeta · dgaeta · commit a0c4a95f97da · 2017-02-10T14:30:08.000-08:00
diff --git a/api-extractor/src/DocItemLoader.ts b/api-extractor/src/DocItemLoader.ts
@@ -47,10 +47,7 @@ export default class DocItemLoader {
   }
 
   /**
-   * Attempts to resolve an API item from the provided apiDefinitionRef.
-   * First checks the cache for the package, if not in the cache then the method
-   * will attempt to the locate the associated json file to load the package and
-   * check there. If the API item can not be found the method will return undefined.
+   * {@inheritdoc ApiDocumentation.IReferenceResolver}
    */
   public resolve(apiDefinitionRef: IApiDefinitionReference, reportError: (message: string) => void): IDocItem {
     if (!apiDefinitionRef) {
diff --git a/api-extractor/src/definitions/ApiDocumentation.ts b/api-extractor/src/definitions/ApiDocumentation.ts
@@ -61,6 +61,13 @@ export interface IScopePackageName {
 /**
  * A dependency for ApiDocumentation constructor that abstracts away the function 
  * of resolving an API definition reference.
+ * 
+ * @internalremarks reportError() will be called if the apiDefinitionRef is to a non local 
+ * item and the package of that non local item can not be found. 
+ * If there is no package given and an  item can not be found we will return undefined. 
+ * Once we support local references, we can be sure that reportError will only be 
+ * called once if the item can not be found (and undefined will be retured by the reference 
+ * function).
  */
 export interface IReferenceResolver {
   resolve(apiDefinitionRef: IApiDefinitionReference, reportError: (message: string) => void): IDocItem;
