From f35affe62209fec2dbff54c107f7f556636756cd Mon Sep 17 00:00:00 2001
From: kopareigns <kopareigns@gmail.com>
Date: Tue, 19 Mar 2019 11:32:38 -0400
Subject: [PATCH] Some minimal documentation

---
 src/js/slaveStatsChecker.js | 4 ++++
 src/js/utilJS.js            | 5 +++++
 2 files changed, 9 insertions(+)

diff --git a/src/js/slaveStatsChecker.js b/src/js/slaveStatsChecker.js
index 12b4ef0ec3c..f1893d1ae12 100644
--- a/src/js/slaveStatsChecker.js
+++ b/src/js/slaveStatsChecker.js
@@ -7,6 +7,7 @@ window.SlaveStatsChecker = (function() {
 		tatScore: tatScore
 	};
 
+	/* call as SlaveStatsChecker.checkForLisp() */
 	function hasLisp(slave) {
 		if (State.variables.disableLisping === 1) {
 			return false;
@@ -14,6 +15,7 @@ window.SlaveStatsChecker = (function() {
 		return (slave.lips > 70 || (slave.lipsPiercing + slave.tonguePiercing > 2) || slave.teeth === "gapped");
 	}
 
+	/* call as SlaveStatsChecker.modScore() */
 	/** @param {App.Entity.SlaveState} slave */
 	function modScore(slave) {
 		const V = State.variables;
@@ -22,6 +24,7 @@ window.SlaveStatsChecker = (function() {
 		return V.tatScore + V.piercingScore;
 	}
 
+	/* call as SlaveStatsChecker.piercingScore() */
 	/** @param {App.Entity.SlaveState} slave */
 	function piercingScore(slave) {
 		let score = 0;
@@ -59,6 +62,7 @@ window.SlaveStatsChecker = (function() {
 		return score;
 	}
 
+	/* call as SlaveStatsChecker.tatScore() */
 	/** @param {App.Entity.SlaveState} slave */
 	function tatScore(slave) {
 		let score = 0;
diff --git a/src/js/utilJS.js b/src/js/utilJS.js
index c4ee8120926..3cfc170614c 100644
--- a/src/js/utilJS.js
+++ b/src/js/utilJS.js
@@ -1221,6 +1221,7 @@ App.UI.passageLink = function(linkText, passage, setter, elementType) {
 };
 
 window.SkillIncrease = (function() {
+	/* call as SkillIncrease.Oral() */
 	/** @param {App.Entity.SlaveState} slave */
 	function OralSkillIncrease(slave, skillIncrease) {
 		const He = capFirstChar(slave.pronoun);
@@ -1249,6 +1250,7 @@ window.SkillIncrease = (function() {
 		return r;
 	}
 
+	/* call as SkillIncrease.Vaginal() */
 	/** @param {App.Entity.SlaveState} slave */
 	function VaginalSkillIncrease(slave, skillIncrease) {
 		const He = capFirstChar(slave.pronoun);
@@ -1276,6 +1278,7 @@ window.SkillIncrease = (function() {
 		return r;
 	}
 
+	/* call as SkillIncrease.Anal() */
 	/** @param {App.Entity.SlaveState} slave */
 	function AnalSkillIncrease(slave, skillIncrease) {
 		const He = capFirstChar(slave.pronoun);
@@ -1304,6 +1307,7 @@ window.SkillIncrease = (function() {
 		return r;
 	}
 
+	/* call as SkillIncrease.Whore() */
 	/** @param {App.Entity.SlaveState} slave */
 	function WhoreSkillIncrease(slave, skillIncrease) {
 		const He = capFirstChar(slave.pronoun);
@@ -1332,6 +1336,7 @@ window.SkillIncrease = (function() {
 		return r;
 	}
 
+	/* call as SkillIncrease.Entertain() */
 	/** @param {App.Entity.SlaveState} slave */
 	function EntertainSkillIncrease(slave, skillIncrease) {
 		const He = capFirstChar(slave.pronoun);
-- 
GitLab