Change doc config to include asynciterator declarations

jflipts · Feb 12, 2019 · 800acae · 800acae
1 parent 9e73698
commit 800acae
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/src/Planner.ts b/src/Planner.ts
@@ -39,7 +39,7 @@ export default class Planner implements EventEmitter {
   /**
    * Given an [[IQuery]], it will evaluate the query and return a promise for an AsyncIterator of [[IPath]] instances
    * @param query An [[IQuery]] specifying a route planning query
-   * @returns An AsyncIterator of [[IPath]] instances
+   * @returns An [[AsyncIterator]] of [[IPath]] instances
    */
   public query(query: IQuery): AsyncIterator<IPath> {
     this.emit(EventType.Query, query);

diff --git a/typedoc.config.js b/typedoc.config.js
@@ -11,7 +11,7 @@ module.exports = {
   mode: 'file',
   excludePrivate: true,
   excludeNotExported: false,
-  excludeExternals: false,
-  includeDeclarations: false,
+  excludeExternals: true,
+  includeDeclarations: true,
   theme: 'minimal',
 };