📝 Add more info in .doc README

This commit is contained in:
Pierre Goiffon
2020-01-30 09:22:34 +01:00
parent 367a92b711
commit 7c17be4db6

View File

@@ -23,7 +23,7 @@ Some iTop specific tags were added :
### known limitations:
#### `@see` tags must be very specific:
* always prefix class members with `ClassName::`
* always prefix class members (attributes or methods) with `ClassName::` (do not use self)
* for methods always suffix them with `()`,
* do not reference variables since they are not documented. If you have to, always prefix them with `$`