jhm-ciberman / docs_gm / 511 / 2

Source File

100.0

/src/doc_models/DocProject.ts

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;
        }
}

1	import DocFolder from "./DocFolder";	1✔
2
3	/**
4	* Represents the current GameMaker project that you are documenting.
5	*/
6	export default class DocProject {	1✔
7
8	/**
9	* The name of the GameMaker project in a readable format.
10	* You can use it for titles, or descriptions inside
11	* your documentation.
12	*/
13	public name: string = "";	21✔
14
15	/**
16	* The root folder for the documentation. Normally is the "scripts" folder, but
17	* it can be any other folder, for example the root folder where you put all the
18	* scripts for your GameMaker Marketplace Extension.
19	*/
20	public root: DocFolder = new DocFolder("scripts");	21✔
21
22	/**
23	* Creates an instance of DocProject.
24	* @param {string} name The project name
25	* @memberof DocProject
26	*/
27	constructor(name: string) {
28	this.name = name;	21✔
29	}
30	}