From 997151c734777fc0a4f17e6c9eff90feeea50c5a Mon Sep 17 00:00:00 2001 From: James Ray Date: Sun, 11 Jun 2017 15:41:15 +1000 Subject: Doxygen Link for more information about Doxygen. --- docs/layout-of-source-files.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 `_-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. -- cgit