Documentation Project
  • Introduction
  • Changelog
  • Plugin settings
  • Using the plugin
Powered by GitBook
On this page
  • Where to find the settings?
  • Description of settings

Plugin settings

PreviousChangelogNextUsing the plugin

Last updated 2 years ago

Where to find the settings?

The plugin's settings are in Project Settings -> Plugins -> Documentation Project.

Description of settings

  1. DocumentationRootFolder - by default "Documentation". The path is formed as follows "%PathToProject%/Documentation", if you specify "Content/Documentation" then it will be "%PathToProject%/Content/Documentation".

  2. SourceCodePaths - Here you specify the folders that the plugin will scan for new files that are not documented. These paths are generated in the same way as DocumentationRootFolder.

  3. ScanFilesWithExtensions - files with these extensions will be added to the documentation when scanning the project.

file extension must not include a "dot"