aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorDenton Liu <liu.denton+github@gmail.com>2016-05-25 22:52:11 +0800
committerDenton Liu <liu.denton+github@gmail.com>2016-05-31 01:18:30 +0800
commit2d32041552bf135d9b24b49c8ed526215c82ffdc (patch)
tree64a533d4ff5738da53c88e52590642e0845a48f2 /docs
parenta29aaa3776f028d635307d6ef9a889ea3a01427d (diff)
downloaddexon-solidity-2d32041552bf135d9b24b49c8ed526215c82ffdc.tar
dexon-solidity-2d32041552bf135d9b24b49c8ed526215c82ffdc.tar.gz
dexon-solidity-2d32041552bf135d9b24b49c8ed526215c82ffdc.tar.bz2
dexon-solidity-2d32041552bf135d9b24b49c8ed526215c82ffdc.tar.lz
dexon-solidity-2d32041552bf135d9b24b49c8ed526215c82ffdc.tar.xz
dexon-solidity-2d32041552bf135d9b24b49c8ed526215c82ffdc.tar.zst
dexon-solidity-2d32041552bf135d9b24b49c8ed526215c82ffdc.zip
Named the global function parameters
Diffstat (limited to 'docs')
-rw-r--r--docs/miscellaneous.rst6
-rw-r--r--docs/units-and-global-variables.rst6
2 files changed, 6 insertions, 6 deletions
diff --git a/docs/miscellaneous.rst b/docs/miscellaneous.rst
index da35d9e1..b7a4bb7a 100644
--- a/docs/miscellaneous.rst
+++ b/docs/miscellaneous.rst
@@ -174,14 +174,14 @@ Global Variables
- ``sha3(...) returns (bytes32)``: compute the Ethereum-SHA-3 (KECCAK-256) hash of the (tightly packed) arguments
- ``sha256(...) returns (bytes32)``: compute the SHA-256 hash of the (tightly packed) arguments
- ``ripemd160(...) returns (bytes20)``: compute the RIPEMD-160 hash of the (tightly packed) arguments
-- ``ecrecover(bytes32, uint8, bytes32, bytes32) returns (address)``: recover address associated with the public key from elliptic curve signature
+- ``ecrecover(bytes32 hash, uint8 v, bytes32 r, bytes32 s) returns (address)``: recover address associated with the public key from elliptic curve signature
- ``addmod(uint x, uint y, uint k) returns (uint)``: compute ``(x + y) % k`` where the addition is performed with arbitrary precision and does not wrap around at ``2**256``
- ``mulmod(uint x, uint y, uint k) returns (uint)``: compute ``(x * y) % k`` where the multiplication is performed with arbitrary precision and does not wrap around at ``2**256``
- ``this`` (current contract's type): the current contract, explicitly convertible to ``address``
- ``super``: the contract one level higher in the inheritance hierarchy
-- ``selfdestruct(address)``: destroy the current contract, sending its funds to the given address
+- ``selfdestruct(address recipient)``: destroy the current contract, sending its funds to the given address
- ``<address>.balance`` (``uint256``): balance of the address in Wei
-- ``<address>.send(uint256) returns (bool)``: send given amount of Wei to address, returns ``false`` on failure
+- ``<address>.send(uint256 amount) returns (bool)``: send given amount of Wei to address, returns ``false`` on failure
.. index:: visibility, public, private, external, internal
diff --git a/docs/units-and-global-variables.rst b/docs/units-and-global-variables.rst
index 594807c0..3dc87841 100644
--- a/docs/units-and-global-variables.rst
+++ b/docs/units-and-global-variables.rst
@@ -94,7 +94,7 @@ Mathematical and Cryptographic Functions
compute the SHA-256 hash of the (tightly packed) arguments
``ripemd160(...) returns (bytes20)``:
compute RIPEMD-160 hash of the (tightly packed) arguments
-``ecrecover(bytes32 data, uint8 v, bytes32 r, bytes32 s) returns (address)``:
+``ecrecover(bytes32 hash, uint8 v, bytes32 r, bytes32 s) returns (address)``:
recover the address associated with the public key from elliptic curve signature
In the above, "tightly packed" means that the arguments are concatenated without padding.
@@ -118,7 +118,7 @@ Address Related
``<address>.balance`` (``uint256``):
balance of the address in Wei
-``<address>.send(uint256) returns (bool)``:
+``<address>.send(uint256 amount) returns (bool)``:
send given amount of Wei to address, returns ``false`` on failure
.. warning::
@@ -134,7 +134,7 @@ Contract Related
``this`` (current contract's type):
the current contract, explicitly convertible to :ref:`address`
-``selfdestruct(address)``:
+``selfdestruct(address recipient)``:
destroy the current contract, sending its funds to the given :ref:`address`
Furthermore, all functions of the current contract are callable directly including the current function.