jhm-ciberman/docs_gm

View on GitHub
src/doc_models/DocProject.ts

Summary

Maintainability
A
0 mins
Test Coverage
import DocFolder from "./DocFolder";

/**
 * Represents the current GameMaker project that you are documenting.
 */
export default class DocProject {

    /**
     * The name of the GameMaker project in a readable format.
     * You can use it for titles, or descriptions inside
     * your documentation.
     */
    public name: string = "";

    /**
     * The root folder for the documentation. Normally is the "scripts" folder, but
     * it can be any other folder, for example the root folder where you put all the
     * scripts for your GameMaker Marketplace Extension.
     */
    public root: DocFolder = new DocFolder("scripts");

    /**
     * Creates an instance of DocProject.
     * @param {string} name The project name
     * @memberof DocProject
     */
    constructor(name: string) {
        this.name = name;
    }
}