Replace jsdoc with typedoc

Use TypeDoc instead of JSDoc because it has better support for
documenting TypeScript APIs.
This commit is contained in:
Hornwitser committed 2023-08-03 15:02:31 +02:00
1 parent 3a321b39e1
commit 74e9ed8257
9 files changed
+33 -47

No files matched your search

+2 -2
View File
@@ -324,7 +324,7 @@ function readMapSettings(state) {
}
/**
* @typedef {object} module:lib.MapExchangeResult
* @typedef {object} MapExchangeResult
* @property {array} version -
* Version of Factorio the string was created with.
* @property {object} map_gen_settings -
@@ -344,7 +344,7 @@ function readMapSettings(state) {
* save to set the map gen settings and the map settings for the save.
*
* @param {string} exchangeString - Max Exchange String to parse.
* @returns {module:lib.MapExchangeResult} Parsed result.
* @returns {MapExchangeResult} Parsed result.
* @memberof module:lib
*/
function readMapExchangeString(exchangeString) {