Escape backticks.

pull/3094/head
chriseth 8 years ago committed by yann300
parent 93ac2f78e6
commit cd264257ea
  1. 30
      contracts/ballot.sol

@ -22,13 +22,13 @@ contract Ballot {
address public chairperson; address public chairperson;
// This declares a state variable that // This declares a state variable that
// stores a `Voter` struct for each possible address. // stores a \`Voter\` struct for each possible address.
mapping(address => Voter) public voters; mapping(address => Voter) public voters;
// A dynamically-sized array of `Proposal` structs. // A dynamically-sized array of \`Proposal\` structs.
Proposal[] public proposals; Proposal[] public proposals;
/// Create a new ballot to choose one of `proposalNames`. /// Create a new ballot to choose one of \`proposalNames\`.
function Ballot(bytes32[] proposalNames) { function Ballot(bytes32[] proposalNames) {
chairperson = msg.sender; chairperson = msg.sender;
voters[chairperson].weight = 1; voters[chairperson].weight = 1;
@ -37,9 +37,9 @@ contract Ballot {
// create a new proposal object and add it // create a new proposal object and add it
// to the end of the array. // to the end of the array.
for (uint i = 0; i < proposalNames.length; i++) { for (uint i = 0; i < proposalNames.length; i++) {
// `Proposal({...})` creates a temporary // \`Proposal({...})\` creates a temporary
// Proposal object and `proposals.push(...)` // Proposal object and \`proposals.push(...)\`
// appends it to the end of `proposals`. // appends it to the end of \`proposals\`.
proposals.push(Proposal({ proposals.push(Proposal({
name: proposalNames[i], name: proposalNames[i],
voteCount: 0 voteCount: 0
@ -47,11 +47,11 @@ contract Ballot {
} }
} }
// Give `voter` the right to vote on this ballot. // Give \`voter\` the right to vote on this ballot.
// May only be called by `chairperson`. // May only be called by \`chairperson\`.
function giveRightToVote(address voter) { function giveRightToVote(address voter) {
if (msg.sender != chairperson || voters[voter].voted) { if (msg.sender != chairperson || voters[voter].voted) {
// `throw` terminates and reverts all changes to // \`throw\` terminates and reverts all changes to
// the state and to Ether balances. It is often // the state and to Ether balances. It is often
// a good idea to use this if functions are // a good idea to use this if functions are
// called incorrectly. But watch out, this // called incorrectly. But watch out, this
@ -61,7 +61,7 @@ contract Ballot {
voters[voter].weight = 1; voters[voter].weight = 1;
} }
/// Delegate your vote to the voter `to`. /// Delegate your vote to the voter \`to\`.
function delegate(address to) { function delegate(address to) {
// assigns reference // assigns reference
Voter sender = voters[msg.sender]; Voter sender = voters[msg.sender];
@ -69,7 +69,7 @@ contract Ballot {
throw; throw;
// Forward the delegation as long as // Forward the delegation as long as
// `to` also delegated. // \`to\` also delegated.
// In general, such loops are very dangerous, // In general, such loops are very dangerous,
// because if they run too long, they might // because if they run too long, they might
// need more gas than is available in a block. // need more gas than is available in a block.
@ -88,8 +88,8 @@ contract Ballot {
throw; throw;
} }
// Since `sender` is a reference, this // Since \`sender\` is a reference, this
// modifies `voters[msg.sender].voted` // modifies \`voters[msg.sender].voted\`
sender.voted = true; sender.voted = true;
sender.delegate = to; sender.delegate = to;
Voter delegate = voters[to]; Voter delegate = voters[to];
@ -105,7 +105,7 @@ contract Ballot {
} }
/// Give your vote (including votes delegated to you) /// Give your vote (including votes delegated to you)
/// to proposal `proposals[proposal].name`. /// to proposal \`proposals[proposal].name\`.
function vote(uint proposal) { function vote(uint proposal) {
Voter sender = voters[msg.sender]; Voter sender = voters[msg.sender];
if (sender.voted) if (sender.voted)
@ -113,7 +113,7 @@ contract Ballot {
sender.voted = true; sender.voted = true;
sender.vote = proposal; sender.vote = proposal;
// If `proposal` is out of the range of the array, // If \`proposal\` is out of the range of the array,
// this will throw automatically and revert all // this will throw automatically and revert all
// changes. // changes.
proposals[proposal].voteCount += sender.weight; proposals[proposal].voteCount += sender.weight;

Loading…
Cancel
Save