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.

Sign up for GitHub

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

Jump to bottom

chore(docs): remove private vars from handlebars template #6995

Merged
merged 1 commit into from
Jan 3, 2023
Merged

chore(docs): remove private vars from handlebars template #6995

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion packages/protocol/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@
"rlp": "^3.0.0",
"solhint": "^3.3.7",
"solidity-coverage": "^0.8.2",
"solidity-docgen": "^0.6.0-beta.29",
"solidity-docgen": "^0.6.0-beta.34",
"ts-node": "^10.5.0",
"typechain": "^5.2.0",
"typescript": "^4.5.5"
Expand Down
5 changes: 3 additions & 2 deletions packages/protocol/solidity-docgen/templates/common.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@
{{{natspec.notice}}}

{{#if natspec.dev}}
{{#unless (eq visibility "internal")}}
_{{{natspec.dev}}}_
{{/unless}}
{{/if}}

{{#if natspec.params}}
Expand All @@ -30,5 +32,4 @@ _{{{natspec.dev}}}_
{{#each returns}}
| {{#if name}}{{name}}{{else}}[{{@index}}]{{/if}} | {{type}} | {{{joinLines natspec}}} |
{{/each}}
{{/if}}

{{/if}}
6 changes: 0 additions & 6 deletions packages/website/docs/smart-contracts/L1/TaikoL1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,6 @@ struct LibData.State state
struct LibData.TentativeState tentative
```

### \_\_gap

```solidity
uint256[50] __gap
```

### init

```solidity
Expand Down
6 changes: 0 additions & 6 deletions packages/website/docs/smart-contracts/L1/TkoToken.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,6 @@

_This is Taiko's governance and fee token._

### \_\_gap

```solidity
uint256[50] __gap
```

### Mint

```solidity
Expand Down
30 changes: 0 additions & 30 deletions packages/website/docs/smart-contracts/L2/TaikoL2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,5 @@
## TaikoL2

### l2Hashes

```solidity
mapping(uint256 => bytes32) l2Hashes
```

### l1Hashes

```solidity
mapping(uint256 => bytes32) l1Hashes
```

### publicInputHash

```solidity
Expand All @@ -24,12 +12,6 @@ bytes32 publicInputHash
bytes32 latestSyncedHeader
```

### \_\_gap

```solidity
uint256[46] __gap
```

### BlockInvalidated

```solidity
Expand Down Expand Up @@ -101,15 +83,3 @@ function getBlockHash(uint256 number) public view returns (bytes32)
```solidity
function getConstants() public pure returns (uint256, uint256, uint256, uint256, uint256, uint256, uint256, uint256, uint256, uint256, uint256)
```

### \_checkPublicInputs

```solidity
function _checkPublicInputs() private
```

### \_hashPublicInputs

```solidity
function _hashPublicInputs(uint256 chainId, uint256 number, uint256 baseFee, bytes32[255] ancestors) private pure returns (bytes32)
```
12 changes: 0 additions & 12 deletions packages/website/docs/smart-contracts/bridge/Bridge.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,6 @@ which calls the library implementations. See {IBridge} for more details.

_The code hash for the same address on L1 and L2 may be different._

### state

```solidity
struct LibBridgeData.State state
```

### \_\_gap

```solidity
uint256[50] __gap
```

### MessageStatusChanged

```solidity
Expand Down
6 changes: 0 additions & 6 deletions packages/website/docs/smart-contracts/bridge/BridgedERC20.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,6 @@ address srcToken
uint256 srcChainId
```

### \_\_gap

```solidity
uint256[48] __gap
```

### BridgeMint

```solidity
Expand Down
12 changes: 0 additions & 12 deletions packages/website/docs/smart-contracts/bridge/EtherVault.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,6 @@

Vault that holds Ether.

### authorizedAddrs

```solidity
mapping(address => bool) authorizedAddrs
```

### \_\_gap

```solidity
uint256[49] __gap
```

### Authorized

```solidity
Expand Down
18 changes: 0 additions & 18 deletions packages/website/docs/smart-contracts/bridge/TokenVault.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,6 @@ mapping(address => struct TokenVault.CanonicalERC20) bridgedToCanonical
mapping(uint256 => mapping(address => address)) canonicalToBridged
```

### \_\_gap

```solidity
uint256[47] __gap
```

### BridgedERC20Deployed

```solidity
Expand Down Expand Up @@ -139,15 +133,3 @@ invoking a message call._
| from | address | The source address. |
| to | address | The destination address. |
| amount | uint256 | The amount of tokens to be sent. 0 is a valid value. |

### \_getOrDeployBridgedToken

```solidity
function _getOrDeployBridgedToken(struct TokenVault.CanonicalERC20 canonicalToken) private returns (address)
```

### \_deployBridgedToken

```solidity
function _deployBridgedToken(struct TokenVault.CanonicalERC20 canonicalToken) private returns (address bridgedToken)
```
12 changes: 0 additions & 12 deletions packages/website/docs/smart-contracts/common/AddressResolver.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,6 @@ it uses an AddressManager to manage the name-to-address mapping.
contract IAddressManager _addressManager
```

### \_\_gap

```solidity
uint256[49] __gap
```

### onlyFromNamed

```solidity
Expand Down Expand Up @@ -91,9 +85,3 @@ Returns the AddressManager's address.
```solidity
function _init(address addressManager_) internal virtual
```

### \_resolve

```solidity
function _resolve(uint256 chainId, string name) private view returns (address payable)
```
6 changes: 0 additions & 6 deletions packages/website/docs/smart-contracts/common/ConfigManager.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,5 @@
## ConfigManager

### kv

```solidity
mapping(bytes32 => bytes) kv
```

### Updated

```solidity
Expand Down
8 changes: 4 additions & 4 deletions pnpm-lock.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.