Built-in Documentation

Updated: 2018-08-28

Bolt will display Unity and .NET documentation from within the editor automatically. It can do the same with your custom scripts and third party plugins, as long as they provide standardized XML documentation.

During the setup wizard, you will be prompted to generate this documentation. However, if you make a change in your scripts, you'll need to update it. To do so, open Tools > Ludiq > Generate Documentation... and click Generate Documentation.

This will attempt to compile your unity projects with an enabled XML documentation switch. This means that if your scripts do not compile at the time of generation, it will fail.

If documentation generation fails, don't panic! It is entirely optional for Bolt to run, and you can skip this step in the setup wizard. If you want more details about the failure, just click Show Log. Usually, your system is just missing MSBuild.

Was this article helpful?
This article was helpful for 3 people.
Yes, helpful
No, not for me