aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorchriseth <chris@ethereum.org>2017-06-12 23:23:55 +0800
committerGitHub <noreply@github.com>2017-06-12 23:23:55 +0800
commit3699d27cc928c6beaef77e4990dacd786469d606 (patch)
tree3ef92993c6b783c3d3aded0e2e36c3449d572a17 /docs
parente48a1a3851f131a328524969203df822369d22c4 (diff)
parent997151c734777fc0a4f17e6c9eff90feeea50c5a (diff)
downloaddexon-solidity-3699d27cc928c6beaef77e4990dacd786469d606.tar
dexon-solidity-3699d27cc928c6beaef77e4990dacd786469d606.tar.gz
dexon-solidity-3699d27cc928c6beaef77e4990dacd786469d606.tar.bz2
dexon-solidity-3699d27cc928c6beaef77e4990dacd786469d606.tar.lz
dexon-solidity-3699d27cc928c6beaef77e4990dacd786469d606.tar.xz
dexon-solidity-3699d27cc928c6beaef77e4990dacd786469d606.tar.zst
dexon-solidity-3699d27cc928c6beaef77e4990dacd786469d606.zip
Merge pull request #2368 from jamesray1/patch-5
Doxygen
Diffstat (limited to 'docs')
-rw-r--r--docs/layout-of-source-files.rst2
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/layout-of-source-files.rst b/docs/layout-of-source-files.rst
index 715b29ae..f4bef82b 100644
--- a/docs/layout-of-source-files.rst
+++ b/docs/layout-of-source-files.rst
@@ -185,7 +185,7 @@ Additionally, there is another type of comment called a natspec comment,
for which the documentation is not yet written. They are written with a
triple slash (``///``) or a double asterisk block(``/** ... */``) and
they should be used directly above function declarations or statements.
-You can use Doxygen-style tags inside these comments to document
+You can use `Doxygen <https://en.wikipedia.org/wiki/Doxygen>`_-style tags inside these comments to document
functions, annotate conditions for formal verification, and provide a
**confirmation text** which is shown to users when they attempt to invoke a
function.