CTRL Documentable is part of the NTY.studio CTRL Framework, a library of utility plugins for Unreal Engine.
CTRL Documentable is a plugin for Unreal Engine 5 that enables game developers to easily generate project documentation for all their Blueprint and C++ classes.
- Selectively include the Blueprint and C++ classes you want to generate documentation for
- Automatic build and local server with node for viewing documentation
- Separated properties, functions, and nodes on a per-class basis
- Search and filtering within properties, functions, and nodes for a given class
- Images generated for Blueprint node classes
- Unreal Engine 5.1+
- node (v??)
Once CTRL Documentable is installed, you will see the window option at the bottom of the "File" menu option to bring up the documentation generator window.
Here you can selectively include which Native Modules you want to include for your C++ classes and which Content Paths you want to include for your Blueprint classes.
Once you hit "Generate Documentation", you'll see a notice in your editor which will persist until the documentation generation has finished. You can also view the status of the documentation generation in your output log.
Assuming you have the correct node version installed per the prerequisites, you will see a local server start and the local generated documentation will open in your browser.
If you come across an issue while using the plugin or have a suggestion to improve the plugin, feel free to open an issue or leave a post in our discord server (CTRL Framework section in discord below).
Contributions from the community are welcome! If you decide to to contribute, we ask that you:
- Fork the repository
- Create a new branch
- Make your changes
- Submit a pull request
This project is licensed under the MIT License - see the LICENSE.md file for details.
Special thanks to https://github.com/kamrann/KantanDocGenPlugin for the original inspiration and base building blocks.