felixfoertsch/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2026-04-17 14:59:16 +02:00
Code Issues Packages Projects Releases Wiki Activity

doc changes

Browse Source
This commit is contained in:
Olivier Gagnon
2021-11-02 14:32:54 -04:00
parent 215932c59c
commit a81a9af1c7
6 changed files with 30 additions and 21947 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
api-extractor.json
View File

@@ -109,7 +109,7 @@
/**
* (REQUIRED) Whether to generate an API report.
*/
"enabled": true
"enabled": true,
/**
* The filename for the API report files. It will be combined with "reportFolder" or "reportTempFolder" to produce
@@ -120,7 +120,7 @@
* SUPPORTED TOKENS: <packageName>, <unscopedPackageName>
* DEFAULT VALUE: "<unscopedPackageName>.api.md"
*/
// "reportFileName": "<unscopedPackageName>.api.md",
// "reportFileName": "markdown/bitburner.api.md"
/**
* Specifies the folder where the API report file is written. The file name portion is determined by
@@ -135,7 +135,7 @@
* SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
* DEFAULT VALUE: "<projectFolder>/etc/"
*/
// "reportFolder": "<projectFolder>/etc/",
"reportFolder": "markdown"
/**
* Specifies the folder where the temporary report file is written. The file name portion is determined by
@@ -160,7 +160,7 @@
/**
* (REQUIRED) Whether to generate a doc model file.
*/
"enabled": true
"enabled": true,
/**
* The output path for the doc model file. The file extension should be ".api.json".
@@ -171,7 +171,7 @@
* SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
* DEFAULT VALUE: "<projectFolder>/temp/<unscopedPackageName>.api.json"
*/
// "apiJsonFilePath": "<projectFolder>/temp/<unscopedPackageName>.api.json"
"apiJsonFilePath": "input/bitburner.api.json"
},
/**