DocumentationSettings.cs

DocumentationSettings

Overview

The DocumentationSettings script is a Unity ScriptableObject that serves as a configuration holder for documentation-related settings within the Indie documentation framework. It allows developers to specify the locations of the scripts and documentation folders, which can be utilized by other parts of the codebase to manage and generate documentation efficiently.

Variables

• scriptsFolder: This variable holds a reference to the folder containing the scripts that are part of the documentation process. It is intended to point to the location where the source code resides.

• documentationFolder: This variable holds a reference to the folder where the generated documentation will be stored. It is used to define the output location for the documentation files.

Functions

The DocumentationSettings class does not contain any functions. It primarily serves as a data container for the specified variables. The functionality of this class is leveraged by other components in the codebase that utilize the paths defined in scriptsFolder and documentationFolder to perform documentation generation tasks.