NoBey/openzeppelin-contracts
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Unify code comments style. (#1603)

Browse Source 
* Updated code style to no more than120 characters per line.

* Unify code comments style with Doxygen-style tags.
This commit is contained in:
skyge
2019-01-26 00:16:40 +08:00
committed by Francisco Giordano
parent a09cf147ea
commit 1fd993bc01
21 changed files with 113 additions and 113 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
contracts/math/Math.sol
View File

@ -6,24 +6,24 @@ pragma solidity ^0.5.2;
*/
library Math {
/**
* @dev Returns the largest of two numbers.
*/
* @dev Returns the largest of two numbers.
*/
function max(uint256 a, uint256 b) internal pure returns (uint256) {
return a >= b ? a : b;
}
/**
* @dev Returns the smallest of two numbers.
*/
* @dev Returns the smallest of two numbers.
*/
function min(uint256 a, uint256 b) internal pure returns (uint256) {
return a < b ? a : b;
}
/**
* @dev Calculates the average of two numbers. Since these are integers,
* averages of an even and odd number cannot be represented, and will be
* rounded down.
*/
* @dev Calculates the average of two numbers. Since these are integers,
* averages of an even and odd number cannot be represented, and will be
* rounded down.
*/
function average(uint256 a, uint256 b) internal pure returns (uint256) {
// (a + b) / 2 can overflow, so we distribute
return (a / 2) + (b / 2) + ((a % 2 + b % 2) / 2);

22
contracts/math/SafeMath.sol
View File

@ -6,8 +6,8 @@ pragma solidity ^0.5.2;
*/
library SafeMath {
/**
* @dev Multiplies two unsigned integers, reverts on overflow.
*/
* @dev Multiplies two unsigned integers, reverts on overflow.
*/
function mul(uint256 a, uint256 b) internal pure returns (uint256) {
// Gas optimization: this is cheaper than requiring 'a' not being zero, but the
// benefit is lost if 'b' is also tested.
@ -23,8 +23,8 @@ library SafeMath {
}
/**
* @dev Integer division of two unsigned integers truncating the quotient, reverts on division by zero.
*/
* @dev Integer division of two unsigned integers truncating the quotient, reverts on division by zero.
*/
function div(uint256 a, uint256 b) internal pure returns (uint256) {
// Solidity only automatically asserts when dividing by 0
require(b > 0);
@ -35,8 +35,8 @@ library SafeMath {
}
/**
* @dev Subtracts two unsigned integers, reverts on overflow (i.e. if subtrahend is greater than minuend).
*/
* @dev Subtracts two unsigned integers, reverts on overflow (i.e. if subtrahend is greater than minuend).
*/
function sub(uint256 a, uint256 b) internal pure returns (uint256) {
require(b <= a);
uint256 c = a - b;
@ -45,8 +45,8 @@ library SafeMath {
}
/**
* @dev Adds two unsigned integers, reverts on overflow.
*/
* @dev Adds two unsigned integers, reverts on overflow.
*/
function add(uint256 a, uint256 b) internal pure returns (uint256) {
uint256 c = a + b;
require(c >= a);
@ -55,9 +55,9 @@ library SafeMath {
}
/**
* @dev Divides two unsigned integers and returns the remainder (unsigned integer modulo),
* reverts when dividing by zero.
*/
* @dev Divides two unsigned integers and returns the remainder (unsigned integer modulo),
* reverts when dividing by zero.
*/
function mod(uint256 a, uint256 b) internal pure returns (uint256) {
require(b != 0);
return a % b;