Merge pull request #8720 from Agoric/ta/typedoc-vats

more typedoc
Agoric · Jan 17, 2024 · 51f64c2 · 51f64c2
2 parents f85d35b + b6f8b6d
commit 51f64c2
Show file tree

Hide file tree

Showing 8 changed files with 48 additions and 6 deletions.
diff --git a/packages/SwingSet/src/types-external.js b/packages/SwingSet/src/types-external.js
@@ -183,7 +183,7 @@ export {};
  * @property {SwingSetConfigDescriptor} [bundles]
  * @property {BundleFormat} [bundleFormat] the bundle source / import bundle
  * format.
- * @property {*} [devices]
+ * @property {any} [devices]
  */
 /**
  * @typedef {KernelOptions & SwingSetOptions} SwingSetConfig a swingset config object
@@ -232,7 +232,7 @@ export {};
  * Vat Creation and Management
  *
  * @typedef { string } BundleID
- * @typedef {*} BundleCap
+ * @typedef {any} BundleCap
  * @typedef { { moduleFormat: 'endoZipBase64', endoZipBase64: string, endoZipBase64Sha512: string } } EndoZipBase64Bundle
  *
  * @typedef { unknown } Meter

diff --git a/packages/SwingSet/typedoc.json b/packages/SwingSet/typedoc.json
@@ -0,0 +1,8 @@
+{
+    "extends": [
+        "../../typedoc.base.json"
+    ],
+    "entryPoints": [
+        "src/index.js",
+    ]
+}
diff --git a/packages/smart-wallet/typedoc.json b/packages/smart-wallet/typedoc.json
@@ -0,0 +1,12 @@
+{
+    "extends": [
+        "../../typedoc.base.json"
+    ],
+    "entryPoints": [
+        "src/invitations.js",
+        "src/offers.js",
+        "src/smartWallet.js",
+        "src/types.d.ts",
+        "src/walletFactory.js",
+    ]
+}
diff --git a/packages/swingset-liveslots/typedoc.json b/packages/swingset-liveslots/typedoc.json
@@ -5,6 +5,6 @@
     "entryPoints": [
         "src/index.js",
         "src/types.js",
-        "src/vatDataTypes.js",
+        "src/vatDataTypes.d.ts",
     ]
 }
diff --git a/packages/vats/README.md b/packages/vats/README.md
@@ -0,0 +1,3 @@
+# Vats
+
+Builders for Vats on the Agoric chain that aren't contracts.
diff --git a/packages/vats/typedoc.json b/packages/vats/typedoc.json
@@ -0,0 +1,9 @@
+{
+    "extends": [
+        "../../typedoc.base.json"
+    ],
+    "entryPoints": [
+        "index.js",
+        "./src/core/types-ambient.d.ts",
+    ]
+}
diff --git a/packages/zoe/typedoc.json b/packages/zoe/typedoc.json
@@ -3,14 +3,16 @@
         "../../typedoc.base.json"
     ],
     "entryPoints": [
+        "src/contractFacet/internal-types.js",
+        "src/contractFacet/types-ambient.d.ts",
         "src/contractSupport/index.js",
         "src/contractSupport/types.js",
-        "src/contractFacet/types-ambient.d.ts",
-        "src/contractFacet/types.ts",
+        "src/types.js",
         "src/zoeService/types.js",
         "src/zoeService/utils.d.ts",
         "src/zoeService/zoe.js",
-        "src/types.js",
+        "tools/internal-types.js",
         "tools/manualTimer.js",
+        "tools/types-ambient.js",
     ]
 }
diff --git a/packages/zone/typedoc.json b/packages/zone/typedoc.json
@@ -0,0 +1,8 @@
+{
+    "extends": [
+        "../../typedoc.base.json"
+    ],
+    "entryPoints": [
+        "src/index.js",
+    ]
+}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Vats

		Builders for Vats on the Agoric chain that aren't contracts.