TypeDoc: update typedoc.json

vocdoni · Mar 28, 2024 · aaccbca · aaccbca
1 parent 4a08096
commit aaccbca
Show file tree

Hide file tree

Showing 151 changed files with 3,004 additions and 6,755 deletions.
diff --git a/docs/protocol/ballot-protocol.md b/docs/protocol/ballot-protocol.md
@@ -22,7 +22,7 @@ The protocol is composed by a set of numeric and boolean variables that restrict
 - `uint8 maxCount`
 Max number of fields per ballot. 1 <= maxCount <= 100.
 - `uint8 maxValue`
-Determines the acceptable maximum value for all fields. If `maxValue` is set to `0`, the results are aggregated.
+Determines the acceptable maximum value for all fields. If `maxValue` is set to 0, the results are aggregated.
 - `uint8 minValue`
 Determines the acceptable minimum value for all fields.
 - `bool uniqueValues`
@@ -37,9 +37,9 @@ Minimum limit on the total sum of all ballot fields' values (if applicable).
 The exponent that will be used to compute the "cost" of the field values.
 - `totalCost = Σ (value[i] ^ costExponent) <= maxTotalCost`
 - `costExponent` is represented as `exp * 10000` so:
-- 0 => 0.0000
-- 10000 => 1.0000
-- 65535 => 6.5535
+  - 0 => 0.0000
+  - 10000 => 1.0000
+  - 65535 => 6.5535
 
 ![https://blog.vocdoni.io/_next/image?url=https%3A%2F%2Fstorage.googleapis.com%2Fpapyrus_images%2Fb8d920f2d64cf347ff2f47f7e34a3340.png&w=1920&q=75](https://blog.vocdoni.io/_next/image?url=https%3A%2F%2Fstorage.googleapis.com%2Fpapyrus_images%2Fb8d920f2d64cf347ff2f47f7e34a3340.png&w=1920&q=75)
 

diff --git a/docs/sdk/index.md b/docs/sdk/index.md
@@ -52,7 +52,7 @@ This SDK is licensed under the [GNU Affero General Public License v3.0][license]
 [builddocs]: https://github.com/vocdoni/vocdoni-sdk/blob/main/docs/README.md
 [chat]: https://chat.vocdoni.io
 [esm-gif]: https://raw.githubusercontent.com/vocdoni/vocdoni-sdk/main/examples/esm/esm.gif
-[reference]: /sdk/reference/modules
+[reference]: /sdk/reference/sdk-reference
 [tutorial]: /sdk/tutorial
 [vocdoni-api]: /vocdoni-api/vocdoni-api
 [license]: https://github.com/vocdoni/vocdoni-sdk/blob/main/LICENSE
diff --git a/docs/sdk/reference/classes/Account.md b/docs/sdk/reference/classes/Account.md
@@ -1,26 +1,11 @@
-[@vocdoni/sdk](/sdk) / [Exports](../modules) / Account
+[@vocdoni/sdk](/sdk) / Account
 
 # Class: Account
 
 Represents an account
 
 ## Table of contents
 
-### Constructors
-
-- [constructor](Account#constructor)
-
-### Properties
-
-- [\_avatar](Account.md#_avatar)
-- [\_description](Account.md#_description)
-- [\_feed](Account.md#_feed)
-- [\_header](Account.md#_header)
-- [\_languages](Account.md#_languages)
-- [\_logo](Account.md#_logo)
-- [\_meta](Account.md#_meta)
-- [\_name](Account.md#_name)
-
 ### Accessors
 
 - [avatar](Account#avatar)
@@ -32,113 +17,15 @@ Represents an account
 - [meta](Account#meta)
 - [name](Account#name)
 
+### Constructors
+
+- [constructor](Account#constructor)
+
 ### Methods
 
 - [generateMetadata](Account#generatemetadata)
 - [build](Account#build)
 
-## Constructors
-
-### constructor
-
-• **new Account**(`params?`): [`Account`](Account)
-
-Constructs an account
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `params?` | [`IAccount`](../interfaces/IAccount) | Account parameters |
-
-#### Returns
-
-[`Account`](Account)
-
-#### Defined in
-
-[types/account.ts:33](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L33)
-
-## Properties
-
-### \_avatar
-
-• `Private` **\_avatar**: `string`
-
-#### Defined in
-
-[types/account.ts:24](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L24)
-
-___
-
-### \_description
-
-• `Private` **\_description**: `MultiLanguage`\<`string`\>
-
-#### Defined in
-
-[types/account.ts:21](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L21)
-
-___
-
-### \_feed
-
-• `Private` **\_feed**: `MultiLanguage`\<`string`\>
-
-#### Defined in
-
-[types/account.ts:22](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L22)
-
-___
-
-### \_header
-
-• `Private` **\_header**: `string`
-
-#### Defined in
-
-[types/account.ts:23](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L23)
-
-___
-
-### \_languages
-
-• `Private` **\_languages**: `string`[]
-
-#### Defined in
-
-[types/account.ts:19](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L19)
-
-___
-
-### \_logo
-
-• `Private` **\_logo**: `string`
-
-#### Defined in
-
-[types/account.ts:25](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L25)
-
-___
-
-### \_meta
-
-• `Private` **\_meta**: \{ `key`: `string` ; `value`: `any`  }[]
-
-#### Defined in
-
-[types/account.ts:26](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L26)
-
-___
-
-### \_name
-
-• `Private` **\_name**: `MultiLanguage`\<`string`\>
-
-#### Defined in
-
-[types/account.ts:20](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L20)
-
 ## Accessors
 
 ### avatar
@@ -151,7 +38,7 @@ ___
 
 #### Defined in
 
-[types/account.ts:108](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L108)
+[types/account.ts:108](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/account.ts#L108)
 
 • `set` **avatar**(`value`): `void`
 
@@ -167,7 +54,7 @@ ___
 
 #### Defined in
 
-[types/account.ts:112](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L112)
+[types/account.ts:112](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/account.ts#L112)
 
 ___
 
@@ -181,7 +68,7 @@ ___
 
 #### Defined in
 
-[types/account.ts:92](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L92)
+[types/account.ts:92](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/account.ts#L92)
 
 • `set` **description**(`value`): `void`
 
@@ -197,7 +84,7 @@ ___
 
 #### Defined in
 
-[types/account.ts:96](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L96)
+[types/account.ts:96](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/account.ts#L96)
 
 ___
 
@@ -211,7 +98,7 @@ ___
 
 #### Defined in
 
-[types/account.ts:124](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L124)
+[types/account.ts:124](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/account.ts#L124)
 
 • `set` **feed**(`value`): `void`
 
@@ -227,7 +114,7 @@ ___
 
 #### Defined in
 
-[types/account.ts:128](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L128)
+[types/account.ts:128](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/account.ts#L128)
 
 ___
 
@@ -241,7 +128,7 @@ ___
 
 #### Defined in
 
-[types/account.ts:100](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L100)
+[types/account.ts:100](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/account.ts#L100)
 
 • `set` **header**(`value`): `void`
 
@@ -257,7 +144,7 @@ ___
 
 #### Defined in
 
-[types/account.ts:104](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L104)
+[types/account.ts:104](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/account.ts#L104)
 
 ___
 
@@ -271,7 +158,7 @@ ___
 
 #### Defined in
 
-[types/account.ts:140](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L140)
+[types/account.ts:140](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/account.ts#L140)
 
 • `set` **languages**(`value`): `void`
 
@@ -287,7 +174,7 @@ ___
 
 #### Defined in
 
-[types/account.ts:144](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L144)
+[types/account.ts:144](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/account.ts#L144)
 
 ___
 
@@ -301,7 +188,7 @@ ___
 
 #### Defined in
 
-[types/account.ts:116](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L116)
+[types/account.ts:116](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/account.ts#L116)
 
 • `set` **logo**(`value`): `void`
 
@@ -317,7 +204,7 @@ ___
 
 #### Defined in
 
-[types/account.ts:120](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L120)
+[types/account.ts:120](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/account.ts#L120)
 
 ___
 
@@ -331,7 +218,7 @@ ___
 
 #### Defined in
 
-[types/account.ts:132](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L132)
+[types/account.ts:132](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/account.ts#L132)
 
 • `set` **meta**(`value`): `void`
 
@@ -347,7 +234,7 @@ ___
 
 #### Defined in
 
-[types/account.ts:136](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L136)
+[types/account.ts:136](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/account.ts#L136)
 
 ___
 
@@ -361,7 +248,7 @@ ___
 
 #### Defined in
 
-[types/account.ts:84](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L84)
+[types/account.ts:84](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/account.ts#L84)
 
 • `set` **name**(`value`): `void`
 
@@ -377,7 +264,29 @@ ___
 
 #### Defined in
 
-[types/account.ts:88](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L88)
+[types/account.ts:88](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/account.ts#L88)
+
+## Constructors
+
+### constructor
+
+• **new Account**(`params?`): [`Account`](Account)
+
+Constructs an account
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `params?` | [`IAccount`](../interfaces/IAccount) | Account parameters |
+
+#### Returns
+
+[`Account`](Account)
+
+#### Defined in
+
+[types/account.ts:33](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/account.ts#L33)
 
 ## Methods
 
@@ -391,7 +300,7 @@ ___
 
 #### Defined in
 
-[types/account.ts:65](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L65)
+[types/account.ts:65](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/account.ts#L65)
 
 ___
 
@@ -413,4 +322,4 @@ Returns an account object
 
 #### Defined in
 
-[types/account.ts:61](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L61)
+[types/account.ts:61](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/account.ts#L61)