From 62fe06404cc93de45b921581abc499e29fe47fe7 Mon Sep 17 00:00:00 2001 From: Henry Harder Date: Thu, 20 Jun 2019 16:11:16 -0700 Subject: [PATCH 1/2] lowercase required for in-page links --- packages/kosu-system-contracts/devdoc.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/kosu-system-contracts/devdoc.js b/packages/kosu-system-contracts/devdoc.js index 1fb8a45c..c35fee7b 100644 --- a/packages/kosu-system-contracts/devdoc.js +++ b/packages/kosu-system-contracts/devdoc.js @@ -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" }, From aef73d916755d782f78041e63738cacb203ce93b Mon Sep 17 00:00:00 2001 From: Henry Harder Date: Thu, 20 Jun 2019 16:13:18 -0700 Subject: [PATCH 2/2] regenerating docs --- .../docs/AuthorizedAddresses.md | 12 +++---- .../docs/EventEmitter.md | 2 +- .../kosu-system-contracts/docs/KosuToken.md | 12 +++---- .../docs/OrderGateway.md | 4 +-- .../docs/PosterRegistry.md | 8 ++--- .../docs/PosterRegistryProxy.md | 10 +++--- .../kosu-system-contracts/docs/Treasury.md | 18 +++++------ .../docs/ValidatorRegistry.md | 32 +++++++++---------- packages/kosu-system-contracts/docs/Voting.md | 14 ++++---- 9 files changed, 56 insertions(+), 56 deletions(-) diff --git a/packages/kosu-system-contracts/docs/AuthorizedAddresses.md b/packages/kosu-system-contracts/docs/AuthorizedAddresses.md index 6436f242..0fe1c3d9 100644 --- a/packages/kosu-system-contracts/docs/AuthorizedAddresses.md +++ b/packages/kosu-system-contracts/docs/AuthorizedAddresses.md @@ -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 diff --git a/packages/kosu-system-contracts/docs/EventEmitter.md b/packages/kosu-system-contracts/docs/EventEmitter.md index f3aca5ef..274b3f7d 100644 --- a/packages/kosu-system-contracts/docs/EventEmitter.md +++ b/packages/kosu-system-contracts/docs/EventEmitter.md @@ -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 diff --git a/packages/kosu-system-contracts/docs/KosuToken.md b/packages/kosu-system-contracts/docs/KosuToken.md index f766d758..4bdc6228 100644 --- a/packages/kosu-system-contracts/docs/KosuToken.md +++ b/packages/kosu-system-contracts/docs/KosuToken.md @@ -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 diff --git a/packages/kosu-system-contracts/docs/OrderGateway.md b/packages/kosu-system-contracts/docs/OrderGateway.md index 7679a48c..a8832306 100644 --- a/packages/kosu-system-contracts/docs/OrderGateway.md +++ b/packages/kosu-system-contracts/docs/OrderGateway.md @@ -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 diff --git a/packages/kosu-system-contracts/docs/PosterRegistry.md b/packages/kosu-system-contracts/docs/PosterRegistry.md index b640aa19..3bb21c86 100644 --- a/packages/kosu-system-contracts/docs/PosterRegistry.md +++ b/packages/kosu-system-contracts/docs/PosterRegistry.md @@ -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 diff --git a/packages/kosu-system-contracts/docs/PosterRegistryProxy.md b/packages/kosu-system-contracts/docs/PosterRegistryProxy.md index 8ee698aa..f733dc61 100644 --- a/packages/kosu-system-contracts/docs/PosterRegistryProxy.md +++ b/packages/kosu-system-contracts/docs/PosterRegistryProxy.md @@ -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 diff --git a/packages/kosu-system-contracts/docs/Treasury.md b/packages/kosu-system-contracts/docs/Treasury.md index 9330a8f2..213dbd89 100644 --- a/packages/kosu-system-contracts/docs/Treasury.md +++ b/packages/kosu-system-contracts/docs/Treasury.md @@ -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 diff --git a/packages/kosu-system-contracts/docs/ValidatorRegistry.md b/packages/kosu-system-contracts/docs/ValidatorRegistry.md index 7e2d99ed..e8665d3a 100644 --- a/packages/kosu-system-contracts/docs/ValidatorRegistry.md +++ b/packages/kosu-system-contracts/docs/ValidatorRegistry.md @@ -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 diff --git a/packages/kosu-system-contracts/docs/Voting.md b/packages/kosu-system-contracts/docs/Voting.md index d5349dcc..51914d41 100644 --- a/packages/kosu-system-contracts/docs/Voting.md +++ b/packages/kosu-system-contracts/docs/Voting.md @@ -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