From 5c7d6cf4b80e99012ed418deca20e105f3ef7cbd Mon Sep 17 00:00:00 2001
From: lowercasedonkey <lowercasedonkey@gmail.com>
Date: Sat, 15 Feb 2020 23:28:20 -0500
Subject: [PATCH] jsdoc fixes
---
src/SecExp/js/secExpState.js | 2 +-
src/js/SlaveState.js | 6 +++---
src/js/datatypeCleanupJS.js | 4 ++--
src/js/descriptionWidgets.js | 8 +++++++-
src/js/rulesAssistant.js | 4 ++--
src/js/slaveGenerationJS.js | 6 +++---
src/player/js/PlayerState.js | 4 ++--
7 files changed, 20 insertions(+), 14 deletions(-)
diff --git a/src/SecExp/js/secExpState.js b/src/SecExp/js/secExpState.js
index 287f0864cc5..4664cc154c6 100644
--- a/src/SecExp/js/secExpState.js
+++ b/src/SecExp/js/secExpState.js
@@ -107,7 +107,7 @@ App.SecExp.SecurityExpansionState = class SecurityExpansionState {
}
/** Creates an object suitable for setting nested attributes as it would be a SecurityExpansionState
- * @returns {object} Object containing all the attributes
+ * @returns {object} object containing all the attributes
* that are complex objects in the SecurityExpansionState class
*/
static makeSecExpSkeleton() {
diff --git a/src/js/SlaveState.js b/src/js/SlaveState.js
index 35af2b51714..28cec7f2c28 100644
--- a/src/js/SlaveState.js
+++ b/src/js/SlaveState.js
@@ -301,7 +301,7 @@ App.Entity.SlaveCustomAddonsState = class SlaveCustomAddonsState {
/** What the slave refers to you as, with a lisp.*/
this.titleLisp = "";
/**
- * @typedef {Object} CustomImage
+ * @typedef {object} CustomImage
* @property {string} filename file name
* @property {string} format one of "png", "jpg", "gif" or "webm"
*/
@@ -2279,7 +2279,7 @@ App.Entity.SlaveState = class SlaveState {
* Sub-object:
* the body part in question, such as back or left hand
* the key of that part is the type of scar they can have and the value is how serious it is, from 0 up
- * @type {object.Object} */
+ * @type {object.object} */
this.scar = {};
/**
* In a eugenics society, this slave is a designated breeder.
@@ -2457,7 +2457,7 @@ App.Entity.SlaveState = class SlaveState {
}
/** Creates an object suitable for setting nested attributes as it would be a SlaveState
- * @returns {object} Object containing all the attributes
+ * @returns {object} object containing all the attributes
* that are complex objects in the SlaveState class
*/
static makeSkeleton() {
diff --git a/src/js/datatypeCleanupJS.js b/src/js/datatypeCleanupJS.js
index 60ef44a356f..eeb7d700abb 100644
--- a/src/js/datatypeCleanupJS.js
+++ b/src/js/datatypeCleanupJS.js
@@ -2313,7 +2313,7 @@ App.Entity.Utils.RARuleDatatypeCleanup = function() {
}
}
- /** @param {Object} o */
+ /** @param {object} o */
function replaceDefaultValues(o) {
for (const [k, v] of Object.entries(o)) {
if (v === "no default setting" || v === "no default change" || Number.isNaN(v) || v === undefined) {
@@ -2510,7 +2510,7 @@ App.Entity.Utils.validateRules = function() {
}
};
-/** @param {Object} subject */
+/** @param {object} subject */
App.Entity.Utils.migratePronouns = function(subject) {
if (subject.pronoun === undefined || typeof subject.pronoun === 'number') {
return;
diff --git a/src/js/descriptionWidgets.js b/src/js/descriptionWidgets.js
index 08c286a22ea..3023d5cbf7b 100644
--- a/src/js/descriptionWidgets.js
+++ b/src/js/descriptionWidgets.js
@@ -1536,7 +1536,13 @@ App.Desc.sexualHistory = function(slave) {
const totalSex = sexTypes.reduce((res, el) => res += slave.counter[el], 0);
if (totalSex > 0) {
r += `and has been fucked about ${num(totalSex)} times, including `;
- const sexNames = {mammary: "mammary", vaginal: "vanilla", anal: "anal", penetrative: "penetrating", oral: "oral"};
+ const sexNames = {
+ mammary: "mammary",
+ vaginal: "vanilla",
+ anal: "anal",
+ penetrative: "penetrating",
+ oral: "oral"
+ };
r += sexTypes.filter((t) => slave.counter[t] > 0)
.map((t) => `${num(slave.counter[t])} ${sexNames[t]}`)
.reduce((res, ch, i, arr) => res + (i === arr.length - 1 ? ' and ' : ', ') + ch);
diff --git a/src/js/rulesAssistant.js b/src/js/rulesAssistant.js
index 2e1a0a50039..ae2c0f75640 100644
--- a/src/js/rulesAssistant.js
+++ b/src/js/rulesAssistant.js
@@ -478,14 +478,14 @@ window.RASummaryCell = function() {
}
/**
- * @callback ObjectWalker
+ * @callback objectWalker
* @param {object} obj
* @param {string[]} memberPath
*/
/**
* @param {object} obj
- * @param {ObjectWalker} walker
+ * @param {objectWalker} walker
* @param {string[]} path
*/
function walkObject(obj, walker, path) {
diff --git a/src/js/slaveGenerationJS.js b/src/js/slaveGenerationJS.js
index c4de55dadbd..d69fa16847b 100644
--- a/src/js/slaveGenerationJS.js
+++ b/src/js/slaveGenerationJS.js
@@ -28,8 +28,8 @@ window.raceToNationality = function raceToNationality(slave) {
};
/**
- * @param {string | Object} nationality
- * @param {string | Object} race
+ * @param {string | object} nationality
+ * @param {string | object} race
* @param {boolean} male
* @param {undefined} [filter] Default: allow all
* @returns {string}
@@ -70,7 +70,7 @@ window.generateSurname = function generateSurname(nationality, race, male, filte
/**
* @param {string} name
- * @param {string | Object} nationality
+ * @param {string | object} nationality
* @param {any} race
* @returns {boolean}
*/
diff --git a/src/player/js/PlayerState.js b/src/player/js/PlayerState.js
index c5429804176..03965b9d258 100644
--- a/src/player/js/PlayerState.js
+++ b/src/player/js/PlayerState.js
@@ -1851,7 +1851,7 @@ App.Entity.PlayerState = class PlayerState {
* Sub-object:
* the body part in question, such as back or left hand
* the key of that part is the type of scar they can have and the value is how serious it is, from 0 up
- * @type {object.Object} */
+ * @type {object.object} */
this.scar = {};
/**
* In a eugenics society, you are a designated breeder.
@@ -1972,7 +1972,7 @@ App.Entity.PlayerState = class PlayerState {
}
/** Creates an object suitable for setting nested attributes as it would be a SlaveState
- * @returns {object} Object containing all the attributes
+ * @returns {object} object containing all the attributes
* that are complex objects in the SlaveState class
*/
static makeSkeleton() {
--
GitLab