aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorssonicblue <ssonicblue@users.noreply.github.com>2016-04-20 19:53:36 +0800
committerssonicblue <ssonicblue@users.noreply.github.com>2016-04-20 19:53:36 +0800
commit5a1f892361ec36fd3a7fd66b571e01af9f0e0385 (patch)
tree30a6f2ec15ab27ba883d1040b59d4ed25dd6a626 /docs
parent81ae2a78321fddcd2d32efc51568ebeca28866a8 (diff)
downloaddexon-solidity-5a1f892361ec36fd3a7fd66b571e01af9f0e0385.tar.gz
dexon-solidity-5a1f892361ec36fd3a7fd66b571e01af9f0e0385.tar.zst
dexon-solidity-5a1f892361ec36fd3a7fd66b571e01af9f0e0385.zip
Update natspec summary in layout-of-source-files.rst
Update the summary on natspec comments for clarity in what they do and how they should be used.
Diffstat (limited to 'docs')
-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..76c13ae3 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(`/** ... */`).
+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.