commit 1280d164b28cce0cef7a3b2031a795e4504af8e5
parent e38a017a7ccede04acd8f04e20cfde0953c6b8e6
Author: Florian Dold <dold@taler.net>
Date: Fri, 4 Sep 2026 21:51:37 +0200
fix typedoc warnings
Diffstat:
9 files changed, 27 insertions(+), 21 deletions(-)
diff --git a/packages/taler-util/src/aml/events.ts b/packages/taler-util/src/aml/events.ts
@@ -52,8 +52,6 @@ export type EventMapInfo<T> = {
*
* return false if there is no enough information to decide.
*
- * @param prevLimits current active decision limits, undefined if this account has no active decision yet
- * @param nextLimits limits of the decision to be made, undefined if not yet decided
* @param prevState current active decision properties, undefined if this account has no active decision yet
* @param nextState new properties of the account defined by the decision, undefined if not yet decided
* @param newAttributes new information added by this decision
diff --git a/packages/taler-util/src/aml/properties.ts b/packages/taler-util/src/aml/properties.ts
@@ -32,7 +32,6 @@ export type PropertiesDerivationFunctionByPropertyName<T extends string> = {
*
* @param formId the current form being filled by the officer
* @param newAttributes the values of the current form
- * @param limits
* @param state the current state of the account
* @returns
*/
diff --git a/packages/taler-util/src/http-client/donau-client.ts b/packages/taler-util/src/http-client/donau-client.ts
@@ -144,7 +144,7 @@ export class DonauHttpClient {
/**
* https://docs.taler.net/core/api-donau.html#csr-issue
*
- * @param args
+ * @param body receipt preparation request
* @returns
*/
async prepareIssueReceipt(body: IssuePrepareRequest) {
@@ -170,7 +170,8 @@ export class DonauHttpClient {
/**
* https://docs.taler.net/core/api-donau.html#post--batch-issue-$CHARITY_ID
*
- * @param args
+ * @param charityId charity receiving the receipts
+ * @param body receipt issuance request
* @returns
*/
async issueReceipts(charityId: number, body: IssueReceiptsRequest) {
@@ -202,7 +203,7 @@ export class DonauHttpClient {
/**
* https://docs.taler.net/core/api-donau.html#post--batch-submit
*
- * @param args
+ * @param body receipts to submit
* @returns
*/
async submitDonationReceipts(body: SubmitDonationReceiptsRequest) {
@@ -226,7 +227,8 @@ export class DonauHttpClient {
/**
* https://docs.taler.net/core/api-donau.html#get--donation-statement-$YEAR-$HASH_DONOR_ID
*
- * @param args
+ * @param year statement year
+ * @param hash donor identifier hash
* @returns
*/
async getDonationStatement(year: number, hash: string) {
@@ -257,7 +259,7 @@ export class DonauHttpClient {
/**
* https://docs.taler.net/core/api-donau.html#get--charities
*
- * @param args
+ * @param token access token
* @returns
*/
async getCharities(token: AccessToken): Promise<OperationOk<Charities>> {
@@ -307,7 +309,8 @@ export class DonauHttpClient {
/**
* https://docs.taler.net/core/api-donau.html#post--charities
*
- * @param args
+ * @param token access token
+ * @param body charity creation request
* @returns
*/
async createCharity(token: AccessToken, body: CharityRequest) {
diff --git a/packages/taler-util/src/http-client/exchange-client.ts b/packages/taler-util/src/http-client/exchange-client.ts
@@ -171,7 +171,7 @@ export enum TalerExchangeCacheEviction {
}
/**
- * Render @a formats, most preferred first, as an "Accept" header value.
+ * Render `formats`, most preferred first, as an "Accept" header value.
*
* Position in the list carries no meaning in HTTP: entries without a weight
* all default to q=1, which makes them equally acceptable and leaves the
diff --git a/packages/taler-util/src/http-client/officer-account.ts b/packages/taler-util/src/http-client/officer-account.ts
@@ -35,8 +35,7 @@ import {
/**
* Restore previous session and unlock account with password
*
- * @param salt string from which crypto params will be derived
- * @param key secured private key
+ * @param account protected private key
* @param password password for the private key
* @returns
*/
@@ -75,8 +74,8 @@ export type Password = { __pwd: string; [__password]: true };
* Create new account (secured private key)
* secured with the given password
*
- * @param sessionId
- * @param password
+ * @param password password used to encrypt the private key
+ * @param extraNonce extra entropy mixed into the encryption nonce
* @returns
*/
export async function createNewOfficerAccount(
diff --git a/packages/taler-util/src/operation.ts b/packages/taler-util/src/operation.ts
@@ -200,7 +200,7 @@ export function opFixedAlternativeFailure<T, B>(
* Constructor of a failure response of the API that is already documented in the spec.
* The `case` parameter is a reason of the error.
* If detail is not defined it will try to parse the json response
- * @param case
+ * @param _case
* @param resp
* @returns
*/
@@ -257,7 +257,7 @@ export async function opUnknownHttpFailure(
* Constructor of a failure response of the API that is already documented in the spec.
* The `case` parameter is a reason of the error.
*
- * @param case
+ * @param _case
* @param resp
* @returns
*/
diff --git a/packages/taler-util/src/time.ts b/packages/taler-util/src/time.ts
@@ -768,9 +768,9 @@ export namespace AbsoluteTime {
}
/**
- * Get the remaining duration until {@param t1}.
+ * Get the remaining duration until `t1`.
*
- * If {@param t1} already happened, the remaining duration
+ * If `t1` already happened, the remaining duration
* is zero.
*/
export function remaining(t1: AbsoluteTime): Duration {
diff --git a/packages/taler-util/src/types-taler-wallet.ts b/packages/taler-util/src/types-taler-wallet.ts
@@ -2809,7 +2809,7 @@ export type GetChoicesForPaymentResult = {
choices: ChoiceSelectionDetail[];
/**
- * Index of the choice in @e choices array to present
+ * Index of the choice in the `choices` array to present
* to the user as default.
*
* Won´t be set if no default selection is configured
@@ -2819,7 +2819,7 @@ export type GetChoicesForPaymentResult = {
defaultChoiceIndex?: number;
/**
- * Whether the choice referenced by @e automaticExecutableIndex
+ * Whether the choice referenced by `automaticExecutableIndex`
* should be confirmed automatically without
* user interaction.
*
@@ -2833,7 +2833,7 @@ export type GetChoicesForPaymentResult = {
/**
* Index of the choice that would be set to automatically
- * execute if the choice was payable. When @e automaticExecution
+ * execute if the choice was payable. When `automaticExecution`
* is set to true, the payment should be confirmed with this
* choice index without user interaction.
*/
diff --git a/tsconfig.defaults.json b/tsconfig.defaults.json
@@ -3,6 +3,13 @@
// extend this config.
{
"compileOnSave": true,
+ "typedocOptions": {
+ "validation": {
+ // Public declarations can refer to implementation types that are not
+ // intended to be package exports.
+ "notExported": false
+ }
+ },
"compilerOptions": {
// General compilation settings
"composite": true,
