| Publisher | UnitySquid |
|---|---|
| File size | 64.22kB |
| Number of files | 16 |
| Latest version | 1 |
| Latest release date | 2019-04-08 01:10:14 |
| First release date | 2019-04-08 01:10:14 |
| Supported Unity versions | 2018.4.2 or higher |
Natural Docs for Unity
Create HTML documentation of your Unity scripts with natural and readable comments. Tested on Windows and macOS.
This plugin uses the Natural Docs application to create HTML documentation from within Unity.
Natural Docs comments are very natural and readable. No need to clutter you comments with fancy XML tags or other complicated syntaxes. But if you want to, you can stick to XML comments too. You can even mix the comments syntax style in your script files.
Requirements
This plugin needs the free Natural Docs documentation generator written by Greg Valure installed on your system.
On macOS you will also need Mono.
Please visit Natural Docs' Getting started guide or UnitySquid's plugin website for installation instructions and further informations.
If you like Natural Docs, please donate to one of the charity projects Grag Valure supports.
Highlights
• Create an HTML documentation with one click
• Document everything or just a certain part of your project
• Easy, natural and readable comments syntax
• Supports classic syntaxes as well (i.e. Microsoft XML, Javadoc)
• Short form comments are also possible
More Infos
UnitySquid's Plugin Site
Natural Docs website
Natural Docs' Getting started guide
Support
Tested on Windows 10 and macOS X High Sierra. As long as Natural Docs is properly installed and working from console everything should be working fine. If you should encounter any problems feel free to take contact.
