From 2296955fb533e84070e65ebc680586f135215943 Mon Sep 17 00:00:00 2001
From: Frankly George <54015-franklygeorge@users.noreply.gitgud.io>
Date: Mon, 18 Mar 2024 15:38:09 +0000
Subject: [PATCH] Require valid JSDoc documentation for functions
---
.eslintrc.json | 6 +++---
src/npc/startingGirls/editFamily.js | 4 ++--
2 files changed, 5 insertions(+), 5 deletions(-)
diff --git a/.eslintrc.json b/.eslintrc.json
index 654730f367b..4921e206fab 100644
--- a/.eslintrc.json
+++ b/.eslintrc.json
@@ -136,12 +136,12 @@
"jsdoc/newline-after-description": 0,
"jsdoc/no-types": 0,
"jsdoc/no-undefined-types": 0,
- "jsdoc/require-jsdoc": 0,
- "jsdoc/require-param": 0,
+ "jsdoc/require-jsdoc": ["warn", { "enableFixer": false }],
+ "jsdoc/require-param": ["warn"],
"jsdoc/require-param-description": 0,
"jsdoc/require-param-name": 1,
"jsdoc/require-param-type": 1,
- "jsdoc/require-returns": 0,
+ "jsdoc/require-returns": ["off"],
"jsdoc/require-returns-check": 1,
"jsdoc/require-returns-description": 0,
"jsdoc/require-returns-type": 1,
diff --git a/src/npc/startingGirls/editFamily.js b/src/npc/startingGirls/editFamily.js
index b341d04c898..b8af59c1efd 100644
--- a/src/npc/startingGirls/editFamily.js
+++ b/src/npc/startingGirls/editFamily.js
@@ -145,7 +145,7 @@ App.Intro.editFamily = function(slave, cheat) {
return div;
}
- /** Set rivalry - Slaves only
+ /** Show the rival status - Slaves only
* @param {App.Entity.SlaveState} slave
*/
function rivalryType(slave) {
@@ -163,7 +163,7 @@ App.Intro.editFamily = function(slave, cheat) {
return el;
}
- /** Set rivalry - Slaves only
+ /** Show the rival status and a link to change it - Slaves only
* @param {App.Entity.SlaveState} slave
*/
function rivalTarget(slave) {
--
GitLab