Skip to content

/ kosu-monorepo

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

kosu-system-contracts: lowercase markdown in-page links #123

Merged
merged 2 commits into from Jun 21, 2019
+57 −57
Merged

kosu-system-contracts: lowercase markdown in-page links #123

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
62fe064
lowercase required for in-page links
hrharder Jun 20, 2019
aef73d9
regenerating docs
hrharder Jun 20, 2019
File filter...
Filter file types
Jump to…
Jump to file or symbol
Failed to load files and symbols.

Always

Just for now

2 packages/kosu-system-contracts/devdoc.js
View file
Open in desktop
@@ -119,7 +119,7 @@ function parseMarkdown(devDoc, methods) {
const contents = [];
for (const method of methods) {
const name = method.name;
contents.push(`[${name}](#${name})`);
contents.push(`[${name}](#${name.toLowerCase()})`);
}
output.push(
{ h2: "Contents" },
12 packages/kosu-system-contracts/docs/AuthorizedAddresses.md
View file
Open in desktop
@@ -5,14 +5,14 @@ Common registry of system contract addresses authrorized to access internal meth
## Contents

- [Methods](undefined)
- [authorizeAddress](#authorizeAddress)
- [authorizeAddress](#authorizeaddress)
- [constructor](#constructor)
- [isAddressAuthorized](#isAddressAuthorized)
- [isOwner](#isOwner)
- [isAddressAuthorized](#isaddressauthorized)
- [isOwner](#isowner)
- [owner](#owner)
- [renounceOwnership](#renounceOwnership)
- [transferOwnership](#transferOwnership)
- [unauthorizeAddress](#unauthorizeAddress)
- [renounceOwnership](#renounceownership)
- [transferOwnership](#transferownership)
- [unauthorizeAddress](#unauthorizeaddress)

## Methods

2 packages/kosu-system-contracts/docs/EventEmitter.md
View file
Open in desktop
@@ -6,7 +6,7 @@ A shared contract for all Kosu system contracts to trigger event logs through.

- [Methods](undefined)
- [constructor](#constructor)
- [emitEvent](#emitEvent)
- [emitEvent](#emitevent)

## Methods

12 packages/kosu-system-contracts/docs/KosuToken.md
View file
Open in desktop
@@ -7,16 +7,16 @@ KosuToken (KOSU) is an implentation of the ERC-20 interface, supporting mints an
- [Methods](undefined)
- [allowance](#allowance)
- [approve](#approve)
- [balanceOf](#balanceOf)
- [balanceOf](#balanceof)
- [burn](#burn)
- [constructor](#constructor)
- [decreaseAllowance](#decreaseAllowance)
- [increaseAllowance](#increaseAllowance)
- [decreaseAllowance](#decreaseallowance)
- [increaseAllowance](#increaseallowance)
- [mint](#mint)
- [mintTo](#mintTo)
- [totalSupply](#totalSupply)
- [mintTo](#mintto)
- [totalSupply](#totalsupply)
- [transfer](#transfer)
- [transferFrom](#transferFrom)
- [transferFrom](#transferfrom)

## Methods

4 packages/kosu-system-contracts/docs/OrderGateway.md
View file
Open in desktop
@@ -5,10 +5,10 @@ Access SubContract implementation's methods to participate in trades and check o
## Contents

- [Methods](undefined)
- [amountRemaining](#amountRemaining)
- [amountRemaining](#amountremaining)
- [arguments](#arguments)
- [constructor](#constructor)
- [isValid](#isValid)
- [isValid](#isvalid)
- [participate](#participate)

## Methods
8 packages/kosu-system-contracts/docs/PosterRegistry.md
View file
Open in desktop
@@ -6,11 +6,11 @@ Implementation contract for the PosterRegistry, allowing users to bond and un-bo

- [Methods](undefined)
- [constructor](#constructor)
- [registerTokens](#registerTokens)
- [releaseTokens](#releaseTokens)
- [registerTokens](#registertokens)
- [releaseTokens](#releasetokens)
- [token](#token)
- [tokensContributed](#tokensContributed)
- [tokensRegisteredFor](#tokensRegisteredFor)
- [tokensContributed](#tokenscontributed)
- [tokensRegisteredFor](#tokensregisteredfor)
- [treasury](#treasury)

## Methods
10 packages/kosu-system-contracts/docs/PosterRegistryProxy.md
View file
Open in desktop
@@ -6,12 +6,12 @@ Proxy contract for interacting with the PosterRegisty implementation contract.

- [Methods](undefined)
- [constructor](#constructor)
- [registerTokens](#registerTokens)
- [releaseTokens](#releaseTokens)
- [setImplementation](#setImplementation)
- [registerTokens](#registertokens)
- [releaseTokens](#releasetokens)
- [setImplementation](#setimplementation)
- [token](#token)
- [tokensContributed](#tokensContributed)
- [tokensRegisteredFor](#tokensRegisteredFor)
- [tokensContributed](#tokenscontributed)
- [tokensRegisteredFor](#tokensregisteredfor)
- [treasury](#treasury)

## Methods
18 packages/kosu-system-contracts/docs/Treasury.md
View file
Open in desktop
@@ -5,19 +5,19 @@ The Kosu Treasury is the central balance management contract with the Kosu syste
## Contents

- [Methods](undefined)
- [adjustBalance](#adjustBalance)
- [adjustBalance](#adjustbalance)
- [award](#award)
- [burnFrom](#burnFrom)
- [claimTokens](#claimTokens)
- [burnFrom](#burnfrom)
- [claimTokens](#claimtokens)
- [confiscate](#confiscate)
- [constructor](#constructor)
- [contractDeposit](#contractDeposit)
- [contractWithdraw](#contractWithdraw)
- [currentBalance](#currentBalance)
- [contractDeposit](#contractdeposit)
- [contractWithdraw](#contractwithdraw)
- [currentBalance](#currentbalance)
- [deposit](#deposit)
- [releaseTokens](#releaseTokens)
- [systemBalance](#systemBalance)
- [updateBalance](#updateBalance)
- [releaseTokens](#releasetokens)
- [systemBalance](#systembalance)
- [updateBalance](#updatebalance)
- [withdraw](#withdraw)

## Methods
32 packages/kosu-system-contracts/docs/ValidatorRegistry.md
View file
Open in desktop
@@ -5,23 +5,23 @@ Stores registry of validator listings and provides functionality to curate throu
## Contents

- [Methods](undefined)
- [challengeListing](#challengeListing)
- [claimRewards](#claimRewards)
- [claimWinnings](#claimWinnings)
- [confirmListing](#confirmListing)
- [challengeListing](#challengelisting)
- [claimRewards](#claimrewards)
- [claimWinnings](#claimwinnings)
- [confirmListing](#confirmlisting)
- [constructor](#constructor)
- [finalizeExit](#finalizeExit)
- [getAllChallenges](#getAllChallenges)
- [getAllListings](#getAllListings)
- [getChallenge](#getChallenge)
- [getChallenges](#getChallenges)
- [getListing](#getListing)
- [getListings](#getListings)
- [initExit](#initExit)
- [listingKeys](#listingKeys)
- [maxRewardRate](#maxRewardRate)
- [registerListing](#registerListing)
- [resolveChallenge](#resolveChallenge)
- [finalizeExit](#finalizeexit)
- [getAllChallenges](#getallchallenges)
- [getAllListings](#getalllistings)
- [getChallenge](#getchallenge)
- [getChallenges](#getchallenges)
- [getListing](#getlisting)
- [getListings](#getlistings)
- [initExit](#initexit)
- [listingKeys](#listingkeys)
- [maxRewardRate](#maxrewardrate)
- [registerListing](#registerlisting)
- [resolveChallenge](#resolvechallenge)

## Methods

14 packages/kosu-system-contracts/docs/Voting.md
View file
Open in desktop
@@ -5,14 +5,14 @@ Voting manages polls and votes on governance matters within the Kosu system.
## Contents

- [Methods](undefined)
- [commitVote](#commitVote)
- [commitVote](#commitvote)
- [constructor](#constructor)
- [createPoll](#createPoll)
- [revealVote](#revealVote)
- [totalRevealedTokens](#totalRevealedTokens)
- [totalWinningTokens](#totalWinningTokens)
- [userWinningTokens](#userWinningTokens)
- [winningOption](#winningOption)
- [createPoll](#createpoll)
- [revealVote](#revealvote)
- [totalRevealedTokens](#totalrevealedtokens)
- [totalWinningTokens](#totalwinningtokens)
- [userWinningTokens](#userwinningtokens)
- [winningOption](#winningoption)

## Methods

ProTip! Use n and p to navigate between commits in a pull request.
You can’t perform that action at this time.