diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/layout-of-source-files.rst | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/docs/layout-of-source-files.rst b/docs/layout-of-source-files.rst index aa6278ba..ef6fd656 100644 --- a/docs/layout-of-source-files.rst +++ b/docs/layout-of-source-files.rst @@ -157,3 +157,23 @@ 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. + +In the following example we document the title of the contract, the explanation +for the two input parameters and two returned values. + +:: + + /** @title Shape calculator.*/ + contract shapeCalculator{ + /**@dev Calculates a rectangle's surface and perimeter. + * @param w Width of the rectangle. + * @param h Height of the rectangle. + * @return s The calculated surface. + * @return p The calculated perimeter. + */ + function rectangle(uint w, uint h) returns (uint s, uint p){ + s = w*h; + p = 2*(w+h); + } + } + |