Create documentation for the project

Hichigo - 代码插件 - 2022/01/26

The plugin allows you to make documentation for your project.

  • 支持的平台
  • 支持的引擎版本
    4.27, 5.0 - 5.1
  • 下载类型
    引擎插件
    此产品包含一款代码插件,含有预编译的二进制文件以及与虚幻引擎集成的所有源代码,能够安装到您选择的引擎版本中,并根据每个项目的需求启动。

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.

技术细节

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