From 7c17be4db6b3c055e0151fee1157d58f94c51a9a Mon Sep 17 00:00:00 2001 From: Pierre Goiffon Date: Thu, 30 Jan 2020 09:22:34 +0100 Subject: [PATCH] :memo: Add more info in .doc README --- .doc/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.doc/README.md b/.doc/README.md index 6221bf2c1..e6c294bc1 100644 --- a/.doc/README.md +++ b/.doc/README.md @@ -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 `$`