Merge branch 'phnaming-cleanup' into 'pregmod-master'

Add JSDOC to penthousenaming.js and replace var with let

See merge request !3715

src/js/PenthouseNaming.js

+/**
+ * @return {string}
+ */
 window.MasterSuiteUIName = function () {
 	const V = State.variables;
-	var name = "";
+	let name = "";
 	if (V.masterSuiteNameCaps === "The Master Suite")
 		name = "Master Suite";
 	else
 		name = V.masterSuiteNameCaps;
 	return `<<link "${name}""Master Suite">><</link>> `;
 };
+/**
+ * @return {string}
+ */
 window.HeadGirlSuiteUIName = function () {
 	const V = State.variables;
-	var name = "";
+	let name = "";
 	if (V.HGSuiteNameCaps === "The Head Girl Suite")
 		name = "Head Girl Suite";
 	else
 		name = V.HGSuiteNameCaps;
 	return `<<link "${name}""Head Girl Suite">><</link>> `;
 };
+/**
+ * @return {string}
+ */
 window.ServantQuartersUIName = function () {
 	const V = State.variables;
-	var name = "";
+	let name = "";
 	if (V.servantsQuartersNameCaps === "The Servants' Quarters")
 		name = "Servants' Quarters";
 	else
 		name = V.servantsQuartersNameCaps;
 	return `<<link "${name}""Servants' Quarters">><</link>> `;
 };
+/**
+ * @return {string}
+ */
 window.SpaUIName = function() {
 	const V = State.variables;
-	var name = "";
+	let name = "";
 	if (V.spaNameCaps === "The Spa")
-		name = "Spa"
+		name = "Spa";
 	else
 		name = V.spaNameCaps;
-	return `<<link "${name}""Spa">><</link>> `}
+	return `<<link "${name}""Spa">><</link>> `;
+};
+/**
+ * @return {string}
+ */
 window.NurseryUIName = function () {
 	const V = State.variables;
-	var name = "";
+	let name = "";
 	if (V.nurseryNameCaps === "The Nursery")
 		name = "Nursery";
 	else
 		name = V.nurseryNameCaps;
 	return `<<link "${name}""Nursery">><</link>> `;
 };
+/**
+ * @return {string}
+ */
 window.ClinicUIName = function () {
 	const V = State.variables;
-	var name = "";
+	let name = "";
 	if (V.clinicNameCaps === "The Clinic")
 		name = "Clinic";
 	else
 		name = V.clinicNameCaps;
 	return `<<link "${name}""Clinic">><</link>> `;
 };
+/**
+ * @return {string}
+ */
 window.SchoolRoomUIName = function () {
 	const V = State.variables;
-	var name = "";
+	let name = "";
 	if (V.schoolroomNameCaps === "The Schoolroom")
 		name = "Schoolroom";
 	else
 		name = V.schoolroomNameCaps;
 	return `<<link "${name}""Schoolroom">><</link>> `;
 };
+/**
+ * @return {string}
+ */
 window.CellblockUIName = function () {
 	const V = State.variables;
-	var name = "";
+	let name = "";
 	if (V.cellblockNameCaps === "The Cellblock")
 		name = "Cellblock";
 	else
 		name = V.cellblockNameCaps;
 	return `<<link "${name}""Cellblock">><</link>> `;
 };
+/**
+ * @return {string}
+ */
 window.IncubatorUIName = function () {
 	const V = State.variables;
-	var name = "";
+	let name = "";
 	if (V.incubatorNameCaps === "The Incubator")
 		name = "Incubator";
 	else

src/js/heroCreator.js

+/**
+ * @param {App.Entity.SlaveState} heroSlave
+ * @param {App.Entity.SlaveState} baseHeroSlave
+ * @return {App.Entity.SlaveState}
+ */
 window.getHeroSlave = function (heroSlave, baseHeroSlave) {
-	var newSlave = clone(baseHeroSlave);
-	for (var attrname in heroSlave) {
+	const newSlave = clone(baseHeroSlave);
+	for (let attrname in heroSlave) {
 		newSlave[attrname] = heroSlave[attrname];
 	}
 	generatePuberty(newSlave);