docs(typedoc): Ignore internal files

- Don't show `parse` and `next` functions in the docs as they might change in
the future.
- Add summary to main package entry point.

Author: danielrbradley

cron-fns.ts

@@ -1,3 +1,8 @@
+/**
+ * Main entry point for the package which exposes the public components.
+ * @packageDocumentation
+ */
+
 export * from "./Cron";
 export * from "./nextCronOccurrence";
 export * from "./nextCronOccurrences";

next.ts

@@ -1,4 +1,9 @@
-import { Field, parse, Schedule } from "./parse";
+/**
+ * @packageDocumentation
+ * @ignore
+ */
+
+import { Field, Schedule } from "./parse";
 
 function findNext(
   current: number,

package.json

@@ -24,7 +24,7 @@
     "clean": "rimraf *.d.ts *.js *.map tests/*.d.ts tests/*.js tests/*.map *.tgz coverage documentation",
     "build": "tsc",
     "test": "jest",
-    "docs": "typedoc --out ./documentation/ --stripInternal ./cron-fns.ts",
+    "doc": "typedoc --out ./documentation/ ./*.ts",
     "commit": "cz",
     "semantic-release": "semantic-release"
   },

parse.ts

@@ -1,3 +1,8 @@
+/**
+ * @packageDocumentation
+ * @ignore
+ */
+
 /** @name Schedule
  *  @description Any field which is undefined is assumed to be unconstrained.
  */