Commit 81a6142f authored by Mart Lubbers's avatar Mart Lubbers
Browse files

Add throws to readme as well

parent 4ae138cb
...@@ -89,18 +89,18 @@ Some simple markup is allowed in documentation: ...@@ -89,18 +89,18 @@ Some simple markup is allowed in documentation:
The tables below describe which fields and documentation types can be used for The tables below describe which fields and documentation types can be used for
different syntax elements, and what they should document. different syntax elements, and what they should document.
| | Description | `@param` | `@result` | `@type` | `@var` | `@representation` | | Description | `@param` | `@result` | `@type` | `@var` | `@representation` | `@throws`
|--------------|-------------|----------|-----------|---------|--------|------------------- |--------------|-------------|----------|-----------|---------|--------|-----------------------------
| Class | ![][y] | ![][y]<sup>1</sup> | ![][y]<sup>1</sup> | | ![][y] | | Class | ![][y] | ![][y]<sup>1</sup> | ![][y]<sup>1</sup> | | ![][y] | ![][y]
| Class member | ![][y] | ![][y] | ![][y] | | | | Class member | ![][y] | ![][y] | ![][y] | | | | ![][y]
| Constructor | ![][y] | | | | | | Constructor | ![][y] | | | | | |
| Function | ![][y] | ![][y] | ![][y] | | | | Function | ![][y] | ![][y] | ![][y] | | | |
| Generic | ![][y] | ![][y] | ![][y] | | ![][y] | | Generic | ![][y] | ![][y] | ![][y] | | ![][y] | |
| Instance | | | | | | | Instance | | | | | | |
| Macro | ![][y] | ![][y] | ![][y] | ![][y]<sup>2</sup> | | | Macro | ![][y] | ![][y] | ![][y] | ![][y]<sup>2</sup> | | |
| Module | ![][y] | | | | | | Module | ![][y] | | | | | |
| Record field | ![][y] | | | | | | Record field | ![][y] | | | | | |
| Type | ![][y] | | | | ![][y] | ![][y], for type synonyms | Type | ![][y] | | | | ![][y] | ![][y], for type synonyms |
<sup>1: only for shorthand classes like `class zero a :: a`, where there is no <sup>1: only for shorthand classes like `class zero a :: a`, where there is no
other place for the documentation of the class member.</sup> other place for the documentation of the class member.</sup>
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment