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