MDS/openide
1
0
Fork 0
mirror of https://gitflic.ru/project/openide/openide.git synced 2026-09-27 10:03:11 +07:00
Code Issues Packages Projects Releases Wiki Activity

annotations: fix formatting of @Contract's javadoc

Browse Source 
Otherwise javadoc generation fails.
This commit is contained in:
nik
2018-03-12 13:33:42 +03:00
parent afe5719650
commit 82a1fd06f4
1 changed files with 7 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
platform/annotations/common/src/org/jetbrains/annotations/Contract.java
+7 -8
View File
@@ -78,14 +78,13 @@ public @interface Contract {
/**
* Contains a specifier which describes which method parameters can be mutated during the method call.
* <p>
* The following values are possible:
* <table>
* <tr><td>"this"</td>Method mutates the receiver object, and doesn't mutates any objects passed as arguments (cannot be applied for static method or constructor)</tr>
* <tr><td>"arg"</td>Method mutates the sole argument and doesn't mutate the receiver object (if applicable)</tr>
* <tr><td>"arg1", "arg2", ...</td>Method mutates the N-th argument</tr>
* <tr><td>"this,arg1"</td>Method mutates the receiver and first argument and doesn't mutate any other arguments</tr>
* </table>
* </p>
* The following values are possible:
* <table summary="">
* <tr><td>"this"</td><td>Method mutates the receiver object, and doesn't mutates any objects passed as arguments (cannot be applied for static method or constructor)</td></tr>
* <tr><td>"arg"</td><td>Method mutates the sole argument and doesn't mutate the receiver object (if applicable)</td></tr>
* <tr><td>"arg1", "arg2", ...</td><td>Method mutates the N-th argument</td></tr>
* <tr><td>"this,arg1"</td><td>Method mutates the receiver and first argument and doesn't mutate any other arguments</td></tr>
* </table>
*
* @return a mutation specifier string
* Warning: This annotation parameter is experimental and may be changed or removed without further notice!