Added basic punctuation to @dev docs (#1697) (#1700)

* Added basic punctuation to @dev docs (#1697)

* add missing uppercase
This commit is contained in:
J Quinn
2019-03-30 20:48:17 +01:00
committed by Francisco Giordano
parent c008f1f0c6
commit 3cb4a00fce
26 changed files with 83 additions and 83 deletions

View File

@ -6,7 +6,7 @@ import "../math/SafeMath.sol";
* @title Counters
* @author Matt Condon (@shrugs)
* @dev Provides counters that can only be incremented or decremented by one. This can be used e.g. to track the number
* of elements in a mapping, issuing ERC721 ids, or counting request ids
* of elements in a mapping, issuing ERC721 ids, or counting request ids.
*
* Include with `using Counters for Counters.Counter;`
* Since it is not possible to overflow a 256 bit integer with increments of one, `increment` can skip the SafeMath

View File

@ -48,7 +48,7 @@ contract SignatureBouncer is SignerRole {
}
/**
* @dev requires that a valid signature of a signer was provided
* @dev Requires that a valid signature of a signer was provided.
*/
modifier onlyValidSignature(bytes memory signature) {
require(_isValidSignature(msg.sender, signature));
@ -56,7 +56,7 @@ contract SignatureBouncer is SignerRole {
}
/**
* @dev requires that a valid signature with a specified method of a signer was provided
* @dev Requires that a valid signature with a specified method of a signer was provided.
*/
modifier onlyValidSignatureAndMethod(bytes memory signature) {
require(_isValidSignatureAndMethod(msg.sender, signature));
@ -64,7 +64,7 @@ contract SignatureBouncer is SignerRole {
}
/**
* @dev requires that a valid signature with a specified method and params of a signer was provided
* @dev Requires that a valid signature with a specified method and params of a signer was provided.
*/
modifier onlyValidSignatureAndData(bytes memory signature) {
require(_isValidSignatureAndData(msg.sender, signature));
@ -108,8 +108,8 @@ contract SignatureBouncer is SignerRole {
}
/**
* @dev internal function to convert a hash to an eth signed message
* and then recover the signature and check it against the signer role
* @dev Internal function to convert a hash to an eth signed message
* and then recover the signature and check it against the signer role.
* @return bool
*/
function _isValidDataHash(bytes32 hash, bytes memory signature) internal view returns (bool) {

View File

@ -2,7 +2,7 @@ pragma solidity ^0.5.2;
/**
* @title SignedSafeMath
* @dev Signed math operations with safety checks that revert on error
* @dev Signed math operations with safety checks that revert on error.
*/
library SignedSafeMath {
int256 constant private INT256_MIN = -2**255;