Create documentation for the project

Hichigo - Code Plugins - Jan 26, 2022

The plugin allows you to make documentation for your project.

  • Supported Platforms
  • Supported Engine Versions
    4.27, 5.0 - 5.1
  • Download Type
    Engine Plugin
    This product contains a code plugin, complete with pre-built binaries and all its source code that integrates with Unreal Engine, which can be installed to an engine version of your choice then enabled on a per-project basis.

Preview video


The plugin allows you to make documentation for your project. Work as a team, scan project files for new documentation files, or add categories manually. Convenient addition of files to git, there will be no problems with merging, since text format is used for storage. A new person on the team can get familiar with the project faster.

Technical Details

Features:

  • Automatic scanning of source code files in a project.
  • Specifying extensions for scanning files.
  • Manual addition of new sections, documents, their editing and deletion.
  • Actions via context menu or hotkeys.
  • Saving data in json format.
  • A multi-level tree structure
  • Sorting tree elements, all alphabetically, folders at the top


Code Modules:

  •  DocumentationProject (editor)

Number of C++ Classes: 13

Network Replicated: No

Supported Development Platforms: Win64 (Other not tested)

Supported Target Build Platforms: the plugin is intended only for the editor and will not be included in the game build

Documentation: Link

Example Project: https://gitlab.com/Hichigo/docoverview