Skip to content

Latest commit

 

History

History
22 lines (15 loc) · 1.51 KB

03_documentStructure.md

File metadata and controls

22 lines (15 loc) · 1.51 KB
Raw

BumbleDocGen / Technical description of the project / Renderer / Document structure of generated entities

Document structure of generated entities

By default, the documentation generator offers two options for organizing the structure of generated entity documents:

  1. The standard structure is an entity document next to a parent document. If the document template contained a link to the entity documentation, during the documentation generation process we created a classes directory in the same directory where the parent document was located, and inside this classes directory we created an entity document.

  2. All entity documents are located in a separate directory with the structure of the entire documented project. At the moment this is only available for PHP projects

To enable the second option, you need to connect the built-in plugin:

plugins:
  - class: \BumbleDocGen\LanguageHandler\Php\Plugin\CorePlugin\EntityDocUnifiedPlace\EntityDocUnifiedPlacePlugin
Last page committer: fshcherbanich <[email protected]>
Last modified date: Fri Oct 13 18:40:45 2023 +0300
Page content update date: Mon Nov 06 2023
Made with Bumble Documentation Generator