mirror of
https://github.com/ethereum/solidity
synced 2023-10-03 13:03:40 +00:00
docs: Fix broken internal links using wrong syntax
- These links were using external link syntax instead of `:ref:`. What's worse, Sphinx can't detect when they're broken. - Added missing anchors in some cases.
This commit is contained in:
parent
8402baa45b
commit
192954e8fa
@ -21,7 +21,7 @@ is copied to all the places in the code where they are accessed. For these value
|
|||||||
can sometimes be cheaper than immutable values.
|
can sometimes be cheaper than immutable values.
|
||||||
|
|
||||||
Not all types for constants and immutables are implemented at this time. The only supported types are
|
Not all types for constants and immutables are implemented at this time. The only supported types are
|
||||||
`strings <strings>`_ (only for constants) and `value types <value-types>`_.
|
:ref:`strings <strings>` (only for constants) and :ref:`value types <value-types>`.
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
|
@ -331,7 +331,7 @@ Modifier Overriding
|
|||||||
===================
|
===================
|
||||||
|
|
||||||
Function modifiers can override each other. This works in the same way as
|
Function modifiers can override each other. This works in the same way as
|
||||||
`function overriding <function-overriding>`_ (except that there is no overloading for modifiers). The
|
:ref:`function overriding <function-overriding>` (except that there is no overloading for modifiers). The
|
||||||
``virtual`` keyword must be used on the overridden modifier
|
``virtual`` keyword must be used on the overridden modifier
|
||||||
and the ``override`` keyword must be used in the overriding modifier:
|
and the ``override`` keyword must be used in the overriding modifier:
|
||||||
|
|
||||||
|
@ -114,7 +114,7 @@ In general, ECDSA signatures consist of two parameters,
|
|||||||
parameter called ``v``, that you can use to verify which
|
parameter called ``v``, that you can use to verify which
|
||||||
account's private key was used to sign the message, and
|
account's private key was used to sign the message, and
|
||||||
the transaction's sender. Solidity provides a built-in
|
the transaction's sender. Solidity provides a built-in
|
||||||
function `ecrecover <mathematical-and-cryptographic-functions>`_ that
|
function :ref:`ecrecover <mathematical-and-cryptographic-functions>` that
|
||||||
accepts a message along with the ``r``, ``s`` and ``v`` parameters
|
accepts a message along with the ``r``, ``s`` and ``v`` parameters
|
||||||
and returns the address that was used to sign the message.
|
and returns the address that was used to sign the message.
|
||||||
|
|
||||||
@ -127,7 +127,7 @@ apart. You can do this on the client-side, but doing it inside
|
|||||||
the smart contract means you only need to send one signature
|
the smart contract means you only need to send one signature
|
||||||
parameter rather than three. Splitting apart a byte array into
|
parameter rather than three. Splitting apart a byte array into
|
||||||
its constituent parts is a mess, so we use
|
its constituent parts is a mess, so we use
|
||||||
`inline assembly <assembly>`_ to do the job in the ``splitSignature``
|
:doc:`inline assembly <assembly>` to do the job in the ``splitSignature``
|
||||||
function (the third function in the full contract at the end of this section).
|
function (the third function in the full contract at the end of this section).
|
||||||
|
|
||||||
Computing the Message Hash
|
Computing the Message Hash
|
||||||
|
@ -22,7 +22,7 @@ Every source file should start with a comment indicating its license:
|
|||||||
|
|
||||||
The compiler does not validate that the license is part of the
|
The compiler does not validate that the license is part of the
|
||||||
`list allowed by SPDX <https://spdx.org/licenses/>`_, but
|
`list allowed by SPDX <https://spdx.org/licenses/>`_, but
|
||||||
it does include the supplied string in the `bytecode metadata <metadata>`_.
|
it does include the supplied string in the :ref:`bytecode metadata <metadata>`.
|
||||||
|
|
||||||
If you do not want to specify a license or if the source code is
|
If you do not want to specify a license or if the source code is
|
||||||
not open-source, please use the special value ``UNLICENSED``.
|
not open-source, please use the special value ``UNLICENSED``.
|
||||||
|
@ -1149,7 +1149,7 @@ Add comments above functions or contracts following `doxygen <http://www.doxygen
|
|||||||
of one or multiple lines starting with ``///`` or a
|
of one or multiple lines starting with ``///`` or a
|
||||||
multiline comment starting with ``/**`` and ending with ``*/``.
|
multiline comment starting with ``/**`` and ending with ``*/``.
|
||||||
|
|
||||||
For example, the contract from `a simple smart contract <simple-smart-contract>`_ with the comments
|
For example, the contract from :ref:`a simple smart contract <simple-smart-contract>` with the comments
|
||||||
added looks like the one below::
|
added looks like the one below::
|
||||||
|
|
||||||
// SPDX-License-Identifier: GPL-3.0
|
// SPDX-License-Identifier: GPL-3.0
|
||||||
@ -1176,6 +1176,6 @@ added looks like the one below::
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
It is recommended that Solidity contracts are fully annotated using `NatSpec <natspec>`_ for all public interfaces (everything in the ABI).
|
It is recommended that Solidity contracts are fully annotated using :ref:`NatSpec <natspec>` for all public interfaces (everything in the ABI).
|
||||||
|
|
||||||
Please see the section about `NatSpec <natspec>`_ for a detailed explanation.
|
Please see the section about :ref:`NatSpec <natspec>` for a detailed explanation.
|
||||||
|
@ -160,6 +160,8 @@ more details on error handling and when to use which function.
|
|||||||
|
|
||||||
.. index:: keccak256, ripemd160, sha256, ecrecover, addmod, mulmod, cryptography,
|
.. index:: keccak256, ripemd160, sha256, ecrecover, addmod, mulmod, cryptography,
|
||||||
|
|
||||||
|
.. _mathematical-and-cryptographic-functions:
|
||||||
|
|
||||||
Mathematical and Cryptographic Functions
|
Mathematical and Cryptographic Functions
|
||||||
----------------------------------------
|
----------------------------------------
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user