diff options
| author | James Ray <james.ray0001@gmail.com> | 2017-06-11 13:41:15 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-06-11 13:41:15 +0800 |
| commit | 997151c734777fc0a4f17e6c9eff90feeea50c5a (patch) | |
| tree | c0d238dafea53a9ab9312a283828aafd1735c86f /docs/layout-of-source-files.rst | |
| parent | fe3b46554af07b35f84ca48264830f8c27d4e52e (diff) | |
| download | dexon-solidity-997151c734777fc0a4f17e6c9eff90feeea50c5a.tar.gz dexon-solidity-997151c734777fc0a4f17e6c9eff90feeea50c5a.tar.zst dexon-solidity-997151c734777fc0a4f17e6c9eff90feeea50c5a.zip | |
Doxygen
Link for more information about Doxygen.
Diffstat (limited to 'docs/layout-of-source-files.rst')
| -rw-r--r-- | docs/layout-of-source-files.rst | 2 |
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. |