Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

more typedoc #8720

Merged
merged 7 commits into from
Jan 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/SwingSet/src/types-external.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
8 changes: 8 additions & 0 deletions packages/SwingSet/typedoc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"extends": [
"../../typedoc.base.json"
],
"entryPoints": [
"src/index.js",
]
}
12 changes: 12 additions & 0 deletions packages/smart-wallet/typedoc.json
Original file line number Diff line number Diff line change
@@ -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",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

walletFactory doesn't subsume the others as entry points?

(interesting that we don't have a "main" key in smart-wallet/package.json)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nope. I added these after getting warnings like,

[warning] InvitationSpec, defined in ./packages/smart-wallet/src/invitations.js, is referenced by offers.OfferSpec.__type.invitationSpec but not included in the documentation.
[warning] Petname, defined in ./packages/smart-wallet/src/types.d.ts, is referenced by smartWallet.BrandDescriptor.__type.petname but not included in the documentation.
[warning] MakeOfferWatcher, defined in ./packages/smart-wallet/src/offerWatcher.js, is referenced by smartWallet.ExecutorPowers.__type.makeOfferWatcher but not included in the documentation.
[warning] BrandDescriptor, defined in ./packages/smart-wallet/src/walletFactory.js, is referenced by walletFactory.makeAssetRegistry.makeAssetRegistry.__type.get.__type.__type but not included in the documentation.

]
}
2 changes: 1 addition & 1 deletion packages/swingset-liveslots/typedoc.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@
"entryPoints": [
"src/index.js",
"src/types.js",
"src/vatDataTypes.js",
"src/vatDataTypes.d.ts",
]
}
3 changes: 3 additions & 0 deletions packages/vats/README.md
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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

there are some contracts here too; mintHolder and centralSupply come to mind.
But this will do for now.

9 changes: 9 additions & 0 deletions packages/vats/typedoc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"extends": [
"../../typedoc.base.json"
],
"entryPoints": [
"index.js",
"./src/core/types-ambient.d.ts",
]
}
8 changes: 5 additions & 3 deletions packages/zoe/typedoc.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
]
}
8 changes: 8 additions & 0 deletions packages/zone/typedoc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"extends": [
"../../typedoc.base.json"
],
"entryPoints": [
"src/index.js",
]
}
Loading