Skip to content

Commit 96705e0

Browse files
authored
Update README.md
1 parent beaa494 commit 96705e0

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,15 @@ Right-click a script asset then click "Generate Markdown Documentation".
1313

1414
## Limitations:
1515

16-
- Only supports Tooltip attributes for properties.
1716
- Only documents the class that shares the script file name.
17+
- Namespace names and assembly names must match.
1818
- Only documents public properties, methods and fields.
1919
- XML Summary comment support is WIP.
20-
- Namespace names and assembly names must match.
20+
21+
## Comment Support:
22+
23+
- Tooltip attributes for properties.
24+
- Parameter XML comments for methods.
2125

2226
## Example:
2327

0 commit comments

Comments
 (0)