Skip to content

Commit 46ecc86

Browse files
committed
docs: documentation warning flags
This commit documents the flags used to enable warning-as-error treatment of not properly documented functions, properties and lambdas. Signed-off-by: Patryk Wrobel <[email protected]>
1 parent c7f7255 commit 46ecc86

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

docs/lime_markdown.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,9 @@ Structured comments are supported for functions. The following syntax is used:
4949

5050
>**Important:** return values (except `Void`) and parameters of functions must be documented. If appropriate comment is
5151
> missing for any parameter or return value, then Gluecodium will raise warning or error depending on `werror` flag.
52+
>
53+
> In order to enable warning-as-error flag to prevent introduction of new comments for functions, which do not meet the
54+
> requirements please use `LimeFunctionDocs` value for `werror` flag.
5255
5356
Example:
5457
```
@@ -73,6 +76,9 @@ At the moment the following annotations are supported:
7376

7477
>**Important:** `@value` annotation is required. Return values of getters and parameters of setters must be documented.
7578
> If appropriate documentation comment is missing, then Gluecodium will raise warning or error depending on `werror` flag.
79+
>
80+
> In order to enable warning-as-error flag to prevent introduction of new comments for properties, which do not meet the
81+
> requirements please use `LimePropertiesDocs` value for `werror` flag.
7682
7783
Example:
7884
```
@@ -112,16 +118,13 @@ Structured comments for lambdas offer the following capabilities:
112118

113119
>**Important:** all parameters and return value (except `Void`) of lambda must be documented. If appropriate documentation
114120
> comment is missing, then Gluecodium will raise warning or error depending on `werror` flag.
121+
>
122+
> In order to enable warning-as-error flag to prevent introduction of new comments for lambdas, which do not meet the
123+
> requirements please use `LimeLambdaDocs` value for `werror` flag.
124+
125+
All documented parameters must be named. If an unnamed parameter is explicitly documented then warning or error is raised
126+
(depending on the flag above).
115127

116-
For unnamed parameters that have only types specified, positional names can be used to document parameters: `p0`, `p1`,
117-
and so on. For example:
118-
```
119-
// Communicate the date and the message.
120-
// @param[p0] the current date.
121-
// @param[p1] the new message.
122-
// @return whether the operation succeeded.
123-
lambda TimestampCallback = (Date, String) -> Boolean
124-
```
125128
For named parameters use the same syntax as for functions. For example:
126129
```
127130
// Communicate the date and the message.

0 commit comments

Comments
 (0)