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

Typedoc warnings on executing "npm run docgen" #2922

Open
Patel-Raj opened this issue Mar 8, 2025 · 0 comments
Open

Typedoc warnings on executing "npm run docgen" #2922

Patel-Raj opened this issue Mar 8, 2025 · 0 comments

Comments

@Patel-Raj
Copy link
Collaborator

Typedoc gives the following warnings when npm run docgen is executed. These warnings needs to be reviewed and fixed.

➜ xrpl.js git:(docgen-issue-fix) npm run docgen

docgen
lerna run docgen --stream

lerna notice cli v4.0.0
lerna info versioning independent
lerna info Executing command in 1 package: "npm run docgen"
xrpl: > xrpl@4.2.0 docgen
xrpl: > tsc --build tsconfig.docs.json && typedoc && echo js.xrpl.org >> ../../docs/CNAME
xrpl: [info] Loaded plugin /Users/ckeshavabs/xrpl.js/packages/xrpl/dist/docs/typedoc.mjs
xrpl: ./src/models/ledger/FeeSettings.ts:51:0 - [warning] Using @interface on a union type will discard properties not present on all branches of the union. TypeDoc's output may not accurately describe your source code
xrpl: 51 type FeeSettings = FeeSettingsBase &
xrpl: [warning] The provided git remote "origin" was not valid. Source links will be broken
xrpl: [warning] AccountTxResponseBase, defined in ./src/models/methods/accountTx.ts, is referenced by AccountTxResponse but not included in the documentation
xrpl: [warning] FeatureAllRequest, defined in ./src/models/methods/feature.ts, is referenced by FeatureRequest but not included in the documentation
xrpl: [warning] FeatureOneRequest, defined in ./src/models/methods/feature.ts, is referenced by FeatureRequest but not included in the documentation
xrpl: [warning] FeatureAllResponse, defined in ./src/models/methods/feature.ts, is referenced by FeatureResponse but not included in the documentation
xrpl: [warning] FeatureOneResponse, defined in ./src/models/methods/feature.ts, is referenced by FeatureResponse but not included in the documentation
xrpl: [warning] AccountTxVersionResponseMap, defined in ./src/models/methods/accountTx.ts, is referenced by RequestAllResponseMap but not included in the documentation
xrpl: [warning] AccountInfoVersionResponseMap, defined in ./src/models/methods/accountInfo.ts, is referenced by RequestResponseMap but not included in the documentation
xrpl: [warning] LedgerVersionResponseMap, defined in ./src/models/methods/ledger.ts, is referenced by Response but not included in the documentation
xrpl: [warning] SubmitMultisignedVersionResponseMap, defined in ./src/models/methods/submitMultisigned.ts, is referenced by Response but not included in the documentation
xrpl: [warning] SimulateJsonResponse, defined in ./src/models/methods/simulate.ts, is referenced by SimulateResponse but not included in the documentation
xrpl: [warning] SimulateBinaryResponse, defined in ./src/models/methods/simulate.ts, is referenced by SimulateResponse but not included in the documentation
xrpl: [warning] PaymentMetadata, defined in ./src/models/transactions/payment.ts, is referenced by TransactionMetadata but not included in the documentation
xrpl: [warning] NFTokenMintMetadata, defined in ./src/models/transactions/NFTokenMint.ts, is referenced by TransactionMetadata but not included in the documentation
xrpl: [warning] NFTokenCreateOfferMetadata, defined in ./src/models/transactions/NFTokenCreateOffer.ts, is referenced by TransactionMetadata but not included in the documentation
xrpl: [warning] NFTokenAcceptOfferMetadata, defined in ./src/models/transactions/NFTokenAcceptOffer.ts, is referenced by TransactionMetadata but not included in the documentation
xrpl: [warning] NFTokenCancelOfferMetadata, defined in ./src/models/transactions/NFTokenCancelOffer.ts, is referenced by TransactionMetadata but not included in the documentation
xrpl: [warning] MPTokenIssuanceCreateMetadata, defined in ./src/models/transactions/MPTokenIssuanceCreate.ts, is referenced by TransactionMetadata but not included in the documentation
xrpl: [warning] TransactionStreamBase, defined in ./src/models/methods/subscribe.ts, is referenced by TransactionStream but not included in the documentation
xrpl: [warning] default, defined in ./src/models/ledger/PermissionedDomain.ts, is referenced by LedgerEntry.LedgerEntry but not included in the documentation
xrpl: [warning] Connection, defined in ./src/client/connection.ts, is referenced by Client.connection but not included in the documentation
xrpl: [warning] GlobalFlags, defined in ./src/models/transactions/common.ts, is referenced by AccountDelete.Flags but not included in the documentation
xrpl: [warning] LedgerResponseResult, defined in ./src/models/methods/ledger.ts, is referenced by LedgerResponse.result but not included in the documentation
xrpl: [warning] LedgerV1ResponseResult, defined in ./src/models/methods/ledger.ts, is referenced by LedgerV1Response.result but not included in the documentation
xrpl: [warning] BaseSubmitMultisignedResult, defined in ./src/models/methods/submitMultisigned.ts, is referenced by SubmitMultisignedResponse.result but not included in the documentation
xrpl: [warning] BaseTxResult, defined in ./src/models/methods/tx.ts, is referenced by TxResponse.result but not included in the documentation
xrpl: [warning] CredentialFlags, defined in ./src/models/ledger/Credential.ts, is referenced by LedgerEntry.Credential.Flags but not included in the documentation
xrpl: [warning] EventTypes, defined in ./src/models/methods/subscribe.ts, is referenced by Client.eventNames but not included in the documentation
xrpl: [warning] RequestNextPageReturnMap, defined in ./src/client/index.ts, is referenced by Client.requestNextPage but not included in the documentation
xrpl: [warning] OnEventToListenerMap, defined in ./src/models/methods/subscribe.ts, is referenced by Client.on.U but not included in the documentation
xrpl: [warning] RequestNextPageType, defined in ./src/client/index.ts, is referenced by Client.requestNextPage.T but not included in the documentation
xrpl: [warning] ServerPort, defined in ./src/models/methods/serverInfo.ts, is referenced by ServerInfoResponse.result.__type.info.__type.ports but not included in the documentation
xrpl: [warning] LedgerVersionMap, defined in ./src/models/ledger/Ledger.ts, is referenced by hashes.__type.hashLedger.__type.ledger but not included in the documentation
xrpl: [warning] Failed to resolve link to "Bridge" in comment for XChainCreateBridge
xrpl: [warning] Failed to resolve link to "Bridge" in comment for XChainCreateClaimID.SignatureReward
xrpl: [warning] Failed to resolve link to "Bridge" in comment for XChainAccountCreateCommit.SignatureReward
xrpl: [warning] Failed to resolve link to "Bridge" in comment for XChainAccountCreateCommit.Amount
xrpl: [info] html generated at /Users/ckeshavabs/xrpl.js/docs
xrpl: [warning] Found 0 errors and 38 warnings
lerna success run Ran npm script 'docgen' in 1 package in 6.8s:
lerna success - xrpl

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant