aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorchriseth <c@ethdev.com>2016-05-06 07:01:26 +0800
committerchriseth <c@ethdev.com>2016-05-06 07:01:26 +0800
commit1b7e2d3068a8870b6d5ebb231cb611d01b4adfc8 (patch)
tree65e0406847815c12669ba106fed21ed248325191
parent30284487f2178c605fd5f414254803d3370341ef (diff)
parent943e27a1c33ecad88aee662af6c35dcd088a22d8 (diff)
downloaddexon-solidity-1b7e2d3068a8870b6d5ebb231cb611d01b4adfc8.tar
dexon-solidity-1b7e2d3068a8870b6d5ebb231cb611d01b4adfc8.tar.gz
dexon-solidity-1b7e2d3068a8870b6d5ebb231cb611d01b4adfc8.tar.bz2
dexon-solidity-1b7e2d3068a8870b6d5ebb231cb611d01b4adfc8.tar.lz
dexon-solidity-1b7e2d3068a8870b6d5ebb231cb611d01b4adfc8.tar.xz
dexon-solidity-1b7e2d3068a8870b6d5ebb231cb611d01b4adfc8.tar.zst
dexon-solidity-1b7e2d3068a8870b6d5ebb231cb611d01b4adfc8.zip
Merge pull request #515 from ssonicblue/patch-1
Update natspec summary in layout-of-source-files.rst
-rw-r--r--docs/layout-of-source-files.rst15
1 files changed, 8 insertions, 7 deletions
diff --git a/docs/layout-of-source-files.rst b/docs/layout-of-source-files.rst
index 48ecfb09..7033a062 100644
--- a/docs/layout-of-source-files.rst
+++ b/docs/layout-of-source-files.rst
@@ -129,10 +129,11 @@ Single-line comments (`//`) and multi-line comments (`/*...*/`) are possible.
*/
-There are special types of comments called natspec comments
-(documentation yet to be written). These are introduced by
-triple-slash comments (`///`) or using double asterisks (`/** ... */`).
-Right in front of function declarations or statements,
-you can use doxygen-style tags inside them to document functions, annotate conditions for formal
-verification and provide a **confirmation text** that is shown to users if they want to
-invoke a function.
+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
+functions, annotate conditions for formal verification, and provide a
+**confirmation text** which is shown to users when they attempt to invoke a
+function.