Fixing #67, don't know how to exclude references

samchon · Apr 18, 2020 · e519900 · e519900
1 parent 3d10ca4
commit e519900
Show file tree

Hide file tree

Showing 204 changed files with 825 additions and 213 deletions.
diff --git a/package.json b/package.json
@@ -10,7 +10,8 @@
   "main": "./index.js",
   "typings": "./index.d.ts",
   "scripts": {
-    "api": "typedoc src --ignoreCompilerErrors --plugin typedoc-plugin-external-module-name --exclude \"**/+(test|benchmark)/**\" --excludePrivate --excludeProtected --excludeNotExported --out ",
+    "api": "typedoc src --exclude \"**/+(test|benchmark)/**\" --excludeNotDocumented --plugin typedoc-plugin-external-module-name --out ../tstl.pages/api",
+    "migration": "ts-node build/migration",
     "benchmark": "node benchmark",
     "build": "npm run clean && npm run module && npm run compile && npm run dist && npm run test",
     "clean": "ts-node build/clean",
@@ -28,8 +29,8 @@
     "cli": "^1.0.1",
     "source-map-support": "^0.5.16",
     "ts-node": "^8.6.2",
-    "typedoc": "^0.14.2",
-    "typedoc-plugin-external-module-name": "^2.0.0",
+    "typedoc": "^0.17.4",
+    "typedoc-plugin-external-module-name": "^3.0.0",
     "typescript": "^3.8.3"
   },
   "homepage": "https://github.com/samchon/tstl",

diff --git a/src/algorithm/binary_search.ts b/src/algorithm/binary_search.ts
@@ -1,5 +1,8 @@
 //================================================================ 
-/** @module std */
+/**
+ * @packageDocumentation
+ * @module std  
+ */
 //================================================================
 import { IForwardIterator } from "../iterator/IForwardIterator";
 import { IPointer } from "../functional/IPointer";

diff --git a/src/algorithm/heap.ts b/src/algorithm/heap.ts
@@ -1,5 +1,8 @@
 //================================================================ 
-/** @module std */
+/**
+ * @packageDocumentation
+ * @module std  
+ */
 //================================================================
 import { IRandomAccessIterator } from "../iterator/IRandomAccessIterator";
 import { IPointer } from "../functional/IPointer";

diff --git a/src/algorithm/index.ts b/src/algorithm/index.ts
@@ -1,5 +1,8 @@
 //================================================================ 
-/** @module std */
+/**
+ * @packageDocumentation
+ * @module std  
+ */
 //================================================================
 // <algorithm>
 //

diff --git a/src/algorithm/iterations.ts b/src/algorithm/iterations.ts
@@ -1,5 +1,8 @@
 //================================================================ 
-/** @module std */
+/**
+ * @packageDocumentation
+ * @module std  
+ */
 //================================================================
 import { IForwardIterator } from "../iterator/IForwardIterator";
 import { IPointer } from "../functional/IPointer";

diff --git a/src/algorithm/mathematics.ts b/src/algorithm/mathematics.ts
@@ -1,5 +1,8 @@
 //================================================================ 
-/** @module std */
+/**
+ * @packageDocumentation
+ * @module std  
+ */
 //================================================================
 import { IForwardIterator } from "../iterator/IForwardIterator";
 import { IBidirectionalIterator } from "../iterator/IBidirectionalIterator";

diff --git a/src/algorithm/merge.ts b/src/algorithm/merge.ts
@@ -1,5 +1,8 @@
 //================================================================ 
-/** @module std */
+/**
+ * @packageDocumentation
+ * @module std  
+ */
 //================================================================
 import { IForwardIterator } from "../iterator/IForwardIterator";
 import { IBidirectionalIterator } from "../iterator/IBidirectionalIterator";

diff --git a/src/algorithm/modifiers.ts b/src/algorithm/modifiers.ts
@@ -1,5 +1,8 @@
 //================================================================ 
-/** @module std */
+/**
+ * @packageDocumentation
+ * @module std  
+ */
 //================================================================
 import { IForwardIterator } from "../iterator/IForwardIterator";
 import { IBidirectionalIterator } from "../iterator/IBidirectionalIterator";

diff --git a/src/algorithm/partition.ts b/src/algorithm/partition.ts
@@ -1,5 +1,8 @@
 //================================================================ 
-/** @module std */
+/**
+ * @packageDocumentation
+ * @module std  
+ */
 //================================================================
 import { IForwardIterator } from "../iterator/IForwardIterator";
 import { IBidirectionalIterator } from "../iterator/IBidirectionalIterator";

diff --git a/src/algorithm/random.ts b/src/algorithm/random.ts
@@ -1,5 +1,8 @@
 //================================================================ 
-/** @module std */
+/**
+ * @packageDocumentation
+ * @module std  
+ */
 //================================================================
 import { IForwardIterator } from "../iterator/IForwardIterator";
 import { IPointer } from "../functional/IPointer";

diff --git a/src/algorithm/sorting.ts b/src/algorithm/sorting.ts
@@ -1,5 +1,8 @@
 //================================================================ 
-/** @module std */
+/**
+ * @packageDocumentation
+ * @module std  
+ */
 //================================================================
 import { IForwardIterator } from "../iterator/IForwardIterator";
 import { IRandomAccessIterator } from "../iterator/IRandomAccessIterator";

diff --git a/src/base/container/Container.ts b/src/base/container/Container.ts
@@ -1,5 +1,8 @@
 //================================================================ 
-/** @module std.base */
+/**
+ * @packageDocumentation
+ * @module std.base  
+ */
 //================================================================
 import { IContainer } from "./IContainer";
 

diff --git a/src/base/container/IArrayContainer.ts b/src/base/container/IArrayContainer.ts
@@ -1,5 +1,8 @@
 //================================================================ 
-/** @module std.base */
+/**
+ * @packageDocumentation
+ * @module std.base  
+ */
 //================================================================
 import { ILinearContainer } from "./ILinearContainer";
 import { IRandomAccessIterator } from "../../iterator/IRandomAccessIterator";

diff --git a/src/base/container/IContainer.ts b/src/base/container/IContainer.ts
@@ -1,5 +1,8 @@
 //================================================================ 
-/** @module std.base */
+/**
+ * @packageDocumentation
+ * @module std.base  
+ */
 //================================================================
 import { IBidirectionalContainer } from "../../ranges/container/IBidirectionalContainer";
 import { IEmpty } from "../../internal/container/partial/IEmpty";

diff --git a/src/base/container/IDequeContainer.ts b/src/base/container/IDequeContainer.ts
@@ -1,5 +1,8 @@
 //================================================================ 
-/** @module std.base */
+/**
+ * @packageDocumentation
+ * @module std.base  
+ */
 //================================================================
 import { IContainer } from "./IContainer";
 import { IDeque } from "../../internal/container/partial/IDeque";

diff --git a/src/base/container/IHashMap.ts b/src/base/container/IHashMap.ts
@@ -1,5 +1,8 @@
 //================================================================ 
-/** @module std.base */
+/**
+ * @packageDocumentation
+ * @module std.base  
+ */
 //================================================================
 import { MapContainer } from "./MapContainer";
 import { IHashContainer } from "../../internal/container/associative/IHashContainer";

diff --git a/src/base/container/IHashSet.ts b/src/base/container/IHashSet.ts
@@ -1,5 +1,8 @@
 //================================================================ 
-/** @module std.base */
+/**
+ * @packageDocumentation
+ * @module std.base  
+ */
 //================================================================
 import { SetContainer } from "./SetContainer";
 import { IHashContainer } from "../../internal/container/associative/IHashContainer";

diff --git a/src/base/container/ILinearContainer.ts b/src/base/container/ILinearContainer.ts
@@ -1,5 +1,8 @@
 //================================================================ 
-/** @module std.base */
+/**
+ * @packageDocumentation
+ * @module std.base  
+ */
 //================================================================
 import { IContainer } from "./IContainer";
 import { ILinearContainerBase } from "../../internal/container/linear/ILinearContainerBase";

diff --git a/src/base/container/ITreeMap.ts b/src/base/container/ITreeMap.ts
@@ -1,5 +1,8 @@
 //================================================================ 
-/** @module std.base */
+/**
+ * @packageDocumentation
+ * @module std.base  
+ */
 //================================================================
 import { MapContainer } from "./MapContainer";
 import { ITreeContainer } from "../../internal/container/associative/ITreeContainer";

diff --git a/src/base/container/ITreeSet.ts b/src/base/container/ITreeSet.ts
@@ -1,5 +1,8 @@
 //================================================================ 
-/** @module std.base */
+/**
+ * @packageDocumentation
+ * @module std.base  
+ */
 //================================================================
 import { SetContainer } from "./SetContainer";
 import { ITreeContainer } from "../../internal/container/associative/ITreeContainer";

diff --git a/src/base/container/MapContainer.ts b/src/base/container/MapContainer.ts
@@ -1,5 +1,8 @@
 //================================================================ 
-/** @module std.base */
+/**
+ * @packageDocumentation
+ * @module std.base  
+ */
 //================================================================
 import { IAssociativeContainer } from "../../internal/container/associative/IAssociativeContainer";
 import { IContainer } from "./IContainer";

diff --git a/src/base/container/MultiMap.ts b/src/base/container/MultiMap.ts
@@ -1,5 +1,8 @@
 //================================================================ 
-/** @module std.base */
+/**
+ * @packageDocumentation
+ * @module std.base  
+ */
 //================================================================
 import { MapContainer } from "./MapContainer";
 

diff --git a/src/base/container/MultiSet.ts b/src/base/container/MultiSet.ts
@@ -1,5 +1,8 @@
 //================================================================ 
-/** @module std.base */
+/**
+ * @packageDocumentation
+ * @module std.base  
+ */
 //================================================================
 import { SetContainer } from "./SetContainer";
 

diff --git a/src/base/container/SetContainer.ts b/src/base/container/SetContainer.ts
@@ -1,5 +1,8 @@
 //================================================================ 
-/** @module std.base */
+/**
+ * @packageDocumentation
+ * @module std.base  
+ */
 //================================================================
 import { IAssociativeContainer } from "../../internal/container/associative/IAssociativeContainer";
 import { IContainer } from "./IContainer";

diff --git a/src/base/container/UniqueMap.ts b/src/base/container/UniqueMap.ts
@@ -1,5 +1,8 @@
 //================================================================ 
-/** @module std.base */
+/**
+ * @packageDocumentation
+ * @module std.base  
+ */
 //================================================================
 import { MapContainer } from "./MapContainer";
 

diff --git a/src/base/container/UniqueSet.ts b/src/base/container/UniqueSet.ts
@@ -1,5 +1,8 @@
 //================================================================ 
-/** @module std.base */
+/**
+ * @packageDocumentation
+ * @module std.base  
+ */
 //================================================================
 import { SetContainer } from "./SetContainer";
 

diff --git a/src/base/container/index.ts b/src/base/container/index.ts
@@ -1,5 +1,8 @@
 //================================================================ 
-/** @module std.base */
+/**
+ * @packageDocumentation
+ * @module std.base  
+ */
 //================================================================
 // LINEAR
 export * from "./IContainer";

diff --git a/src/base/index.ts b/src/base/index.ts
@@ -1,4 +1,10 @@
 //================================================================ 
-/** @module std.base */
+/**
+ * Basic Features
+ * 
+ * @packageDocumentation
+ * @module std.base  
+ * @preferred
+ */
 //================================================================
 export * from "./container/index";
diff --git a/src/benchmark/internal/StringUtil.ts b/src/benchmark/internal/StringUtil.ts
@@ -1,12 +1,5 @@
 /**
- * A utility class supporting static methods of string.
- * 
- * The {@link StringUtil} utility class is an all-static class with methods for working with string objects. 
- * You do not create instances of {@link StringUtil}; instead you call methods such as the 
- * ```StringUtil.substitute()``` method.
- *
- * @reference http://help.adobe.com/en_US/FlashPlatform/reference/actionscript/3/mx/utils/StringUtil.html
- * @author Jeongho Nam - https://github.com/samchon
+ * @hidden
  */
 export class StringUtil
 {

diff --git a/src/container/Deque.ts b/src/container/Deque.ts
@@ -1,5 +1,8 @@
 //================================================================ 
-/** @module std */
+/**
+ * @packageDocumentation
+ * @module std  
+ */
 //================================================================
 import { IArrayContainer } from "../base/container/IArrayContainer";
 import { ArrayContainer } from "../internal/container/linear/ArrayContainer";

diff --git a/src/container/ForwardList.ts b/src/container/ForwardList.ts
@@ -1,5 +1,8 @@
 //================================================================ 
-/** @module std */
+/**
+ * @packageDocumentation
+ * @module std  
+ */
 //================================================================
 import { IForwardContainer } from "../ranges/container/IForwardContainer";
 import { IForwardIterator } from "../iterator/IForwardIterator";

diff --git a/src/container/HashMap.ts b/src/container/HashMap.ts
@@ -1,5 +1,8 @@
 //================================================================ 
-/** @module std */
+/**
+ * @packageDocumentation
+ * @module std  
+ */
 //================================================================
 import { UniqueMap } from "../base/container/UniqueMap";
 import { IHashMap } from "../base/container/IHashMap";

diff --git a/src/container/HashMultiMap.ts b/src/container/HashMultiMap.ts
@@ -1,5 +1,8 @@
 //================================================================ 
-/** @module std */
+/**
+ * @packageDocumentation
+ * @module std  
+ */
 //================================================================
 import { MultiMap } from "../base/container/MultiMap";
 import { IHashMap } from "../base/container/IHashMap";

diff --git a/src/container/HashMultiSet.ts b/src/container/HashMultiSet.ts
@@ -1,5 +1,8 @@
 //================================================================ 
-/** @module std */
+/**
+ * @packageDocumentation
+ * @module std  
+ */
 //================================================================
 import { MultiSet } from "../base/container/MultiSet";
 import { IHashSet } from "../base/container/IHashSet";

diff --git a/src/container/HashSet.ts b/src/container/HashSet.ts
@@ -1,5 +1,8 @@
 //================================================================ 
-/** @module std */
+/**
+ * @packageDocumentation
+ * @module std  
+ */
 //================================================================
 import { UniqueSet } from "../base/container/UniqueSet";
 import { IHashSet } from "../base/container/IHashSet";

diff --git a/src/container/List.ts b/src/container/List.ts
@@ -1,5 +1,8 @@
 //================================================================ 
-/** @module std */
+/**
+ * @packageDocumentation
+ * @module std  
+ */
 //================================================================
 import { ListContainer } from "../internal/container/linear/ListContainer";
 import { IDequeContainer } from "../base/container/IDequeContainer";

diff --git a/src/container/PriorityQueue.ts b/src/container/PriorityQueue.ts
@@ -1,5 +1,8 @@
 //================================================================ 
-/** @module std */
+/**
+ * @packageDocumentation
+ * @module std  
+ */
 //================================================================
 import { AdaptorContainer } from "../internal/container/linear/AdaptorContainer";
 

diff --git a/src/container/Queue.ts b/src/container/Queue.ts
@@ -1,5 +1,8 @@
 //================================================================ 
-/** @module std */
+/**
+ * @packageDocumentation
+ * @module std  
+ */
 //================================================================
 import { AdaptorContainer } from "../internal/container/linear/AdaptorContainer";
 import { List } from "./List";