From bbd3d7908df409d85062481dce65c88d2630970a Mon Sep 17 00:00:00 2001 From: Skriv <skrivelese@gmail.com> Date: Sat, 25 May 2019 13:48:54 +0200 Subject: [PATCH] second pass --- src/endWeek/saWhore.js | 1 - src/js/assayJS.js | 4 ++-- src/js/descriptionWidgets.js | 2 +- src/js/heroCreator.js | 2 +- src/js/rulesAssistant.js | 2 +- src/js/sexActsJS.js | 34 +++++++++++++++++----------------- src/js/slaveListing.js | 18 +++++++++--------- src/js/storyJS.js | 10 +++++----- 8 files changed, 36 insertions(+), 37 deletions(-) diff --git a/src/endWeek/saWhore.js b/src/endWeek/saWhore.js index 2cc8bfc1ab9..6155ba33760 100644 --- a/src/endWeek/saWhore.js +++ b/src/endWeek/saWhore.js @@ -1413,7 +1413,6 @@ window.saWhore = (function saWhore() { } /** - * @param {App.Entity.SlaveState} slave */ function applyFSDecoration() { /* FACILITY DECORATION IMPACTS */ diff --git a/src/js/assayJS.js b/src/js/assayJS.js index 1512dd218a3..417fba5c65b 100644 --- a/src/js/assayJS.js +++ b/src/js/assayJS.js @@ -72,7 +72,7 @@ window.isLeaderP = function isLeaderP(slave) { /** * Helper function returning PC's title * @returns {string} -*/ + */ window.properTitle = function properTitle() { const PC = State.variables.PC; if (PC.customTitle) { @@ -87,7 +87,7 @@ window.properTitle = function properTitle() { /** * Helper function returning slave's title for PC in situations where WrittenMaster() is inappropriate * @returns {string} -*/ + */ window.properMaster = function properMaster() { const PC = State.variables.PC; if (PC.customTitle) { diff --git a/src/js/descriptionWidgets.js b/src/js/descriptionWidgets.js index dd088cc835e..a62bd5e4b77 100644 --- a/src/js/descriptionWidgets.js +++ b/src/js/descriptionWidgets.js @@ -1,6 +1,6 @@ /** * @param {App.Entity.SlaveState} slave - * @return {string} Slave's eyes + * @returns {string} Slave's eyes */ App.Desc.eyes = function(slave) { "use strict"; diff --git a/src/js/heroCreator.js b/src/js/heroCreator.js index 1200dc10bd3..fc109a2b52a 100644 --- a/src/js/heroCreator.js +++ b/src/js/heroCreator.js @@ -1,7 +1,7 @@ /** * @param {App.Entity.SlaveState} heroSlave * @param {App.Entity.SlaveState} baseHeroSlave - * @return {App.Entity.SlaveState} + * @returns {App.Entity.SlaveState} */ App.Utils.getHeroSlave = function(heroSlave, baseHeroSlave) { function isObject(o) { diff --git a/src/js/rulesAssistant.js b/src/js/rulesAssistant.js index d73689da190..295ee026945 100644 --- a/src/js/rulesAssistant.js +++ b/src/js/rulesAssistant.js @@ -404,7 +404,7 @@ window.RulesDeconfliction = function RulesDeconfliction(slave) { /** * Creates a table to summarize RA * @returns {string} -*/ + */ window.RASummaryCell = function RASummaryCell() { const V = State.variables; let r = ""; diff --git a/src/js/sexActsJS.js b/src/js/sexActsJS.js index 3ca88e59963..3a968af5fae 100644 --- a/src/js/sexActsJS.js +++ b/src/js/sexActsJS.js @@ -130,7 +130,7 @@ window.VCheck = (function() { * @param {number} [analTimes=1] how many times to increment the anal counts, if there is no vagina available. * @param {number} [bothTimes=1] how many times to increment both holes counts (usually it is half of analTimes). * @returns {string} - */ + */ function BothVCheck(analTimes = 1, bothTimes = 1) { const V = State.variables; const slave = V.activeSlave; @@ -248,7 +248,7 @@ window.VCheck = (function() { /** call as VCheck.Simple() * @param {number} [times=1] how many times to increment either the Vaginal or the Anal counts, if there is no Vagina available. * @returns {string} - */ + */ function SimpleVCheck(times = 1) { if (canDoVaginal(State.variables.activeSlave)) { return VaginalVCheck(times); @@ -358,13 +358,13 @@ window.SimpleSexAct = function SimpleSexAct(slave, fuckCount = 1) { }; /** - count is how many times to increment either the Vaginal, Anal, or Oral counts, depending on availability of slave. - If count is left undefined it will assume it to be 1. - Intended to be a simple "x got fucked y times and I don't want to keep coding it". - Pregnancy chance is handled in saLongTermEffects.tw. - @param {App.Entity.SlaveState} slave - @param {number} fuckCount -*/ + * count is how many times to increment either the Vaginal, Anal, or Oral counts, depending on availability of slave. + * If count is left undefined it will assume it to be 1. + * Intended to be a simple "x got fucked y times and I don't want to keep coding it". + * Pregnancy chance is handled in saLongTermEffects.tw. + * @param {App.Entity.SlaveState} slave + * @param {number} fuckCount + */ window.SimpleSlaveFucking = function SimpleSlaveFucking(slave, fuckCount = 1) { const V = State.variables; let fuckTarget = 0; @@ -388,14 +388,14 @@ window.SimpleSlaveFucking = function SimpleSlaveFucking(slave, fuckCount = 1) { }; /** - count is how many times to increment either the Vaginal, Anal, or Oral counts, depending on availability of slave. - If count is left undefined it will assume it to be 1. - Intended to be a simple "x got fucked y times by z and I don't want to keep coding it". - @param {App.Entity.SlaveState} subslave - @param {App.Entity.SlaveState} domslave - @param {number} fuckCount - @returns {string} -*/ + * count is how many times to increment either the Vaginal, Anal, or Oral counts, depending on availability of slave. + * If count is left undefined it will assume it to be 1. + * Intended to be a simple "x got fucked y times by z and I don't want to keep coding it". + * @param {App.Entity.SlaveState} subslave + * @param {App.Entity.SlaveState} domslave + * @param {number} fuckCount + * @returns {string} + */ window.SimpleSlaveSlaveFucking = function SimpleSlaveSlaveFucking(subslave, domslave, fuckCount = 1) { const V = State.variables; let fuckTarget = 0; diff --git a/src/js/slaveListing.js b/src/js/slaveListing.js index 844dccd74ac..7c86fa4b538 100644 --- a/src/js/slaveListing.js +++ b/src/js/slaveListing.js @@ -11,7 +11,7 @@ App.UI.SlaveList = {}; * @callback slaveTextGenerator * @param {App.Entity.SlaveState} slave * @param {number} index - * @return {string} + * @returns {string} */ App.UI.SlaveList.render = function() { 'use strict'; @@ -159,8 +159,8 @@ App.UI.SlaveList.render = function() { /** * @param {number[]} indices - * @return {string} - */ + * @returns {string} + */ function createQuickList(indices) { let res = ""; @@ -276,7 +276,7 @@ App.UI.SlaveList.SlaveInteract = {}; /** * @param {App.Entity.SlaveState} slave * @param {number} index - * @return {string} + * @returns {string} */ App.UI.SlaveList.SlaveInteract.stdInteract = (slave, index) => App.UI.passageLink(SlaveFullName(slave), 'Slave Interact', `$activeSlave = $slaves[${index}]`); @@ -285,7 +285,7 @@ App.UI.SlaveList.SlaveInteract.stdInteract = (slave, index) => /** * @param {App.Entity.SlaveState} slave * @param {number} index - * @return {string} + * @returns {string} */ App.UI.SlaveList.SlaveInteract.penthouseInteract = (slave, index) => { return App.UI.SlaveList.Decoration.penthousePositions(slave) + ' ' + App.UI.SlaveList.SlaveInteract.stdInteract(slave, index); @@ -293,7 +293,7 @@ App.UI.SlaveList.SlaveInteract.penthouseInteract = (slave, index) => { /** * @param {App.Entity.SlaveState} slave - * @return {string} + * @returns {string} */ App.UI.SlaveList.SlaveInteract.personalAttention = (slave) => App.UI.passageLink(SlaveFullName(slave), undefined, `App.UI.selectSlaveForPersonalAttention(${slave.ID});`); @@ -301,7 +301,7 @@ App.UI.SlaveList.SlaveInteract.personalAttention = (slave) => /** * @param {App.Entity.SlaveState} slave * @param {number} index - * @return {string} + * @returns {string} */ App.UI.SlaveList.SlaveInteract.assign = (slave, index) => App.UI.passageLink(SlaveFullName(slave), "Assign", `$i = ${index}`); @@ -309,7 +309,7 @@ App.UI.SlaveList.SlaveInteract.assign = (slave, index) => /** * @param {App.Entity.SlaveState} slave * @param {number} index - * @return {string} + * @returns {string} */ App.UI.SlaveList.SlaveInteract.retrieve = (slave, index) => App.UI.passageLink(SlaveFullName(slave), "Retrieve", `$i = ${index}`); @@ -794,7 +794,7 @@ App.UI.SlaveList.slaveSelectionList = function() { * @param {slaveTestCallback} [experianceChecker] * @param {slaveTextGenerator} [postNote] * @returns {string} - */ + */ function selection(filter, interactionLink, experianceChecker, postNote) { if (experianceChecker === null) { experianceChecker = undefined; } State.temporary.slaveSelection = { diff --git a/src/js/storyJS.js b/src/js/storyJS.js index 10eae2183ff..045496c4048 100644 --- a/src/js/storyJS.js +++ b/src/js/storyJS.js @@ -24,7 +24,7 @@ window.variableAsNumber = function(x, defaultValue = 0, minValue, maxValue) { /** * @param {App.Entity.SlaveState} slave - * @return {boolean} + * @returns {boolean} */ window.isSexuallyPure = function(slave) { if (!slave) { @@ -484,10 +484,10 @@ window.overpowerCheck = function(slave, PC) { }; /** -* returns array of IDs of all characters who impregnated slave -* @param {App.Entity.SlaveState} slave -* @returns {number[]} -*/ + * returns array of IDs of all characters who impregnated slave + * @param {App.Entity.SlaveState} slave + * @returns {number[]} + */ window.impregnatedBy = function(slave) { const IDArray = []; if (!Array.isArray(slave.womb)) { -- GitLab