From 0e1215af2495c23ce981ce06bd70b4de9fe34702 Mon Sep 17 00:00:00 2001
From: Skriv <skrivelese@gmail.com>
Date: Sat, 25 May 2019 15:21:15 +0200
Subject: [PATCH] jsdoc

---
 src/js/extendedFamilyModeJS.js | 25 +++++++++++++++----------
 1 file changed, 15 insertions(+), 10 deletions(-)

diff --git a/src/js/extendedFamilyModeJS.js b/src/js/extendedFamilyModeJS.js
index a040b9f2f9e..ddf4573c3be 100644
--- a/src/js/extendedFamilyModeJS.js
+++ b/src/js/extendedFamilyModeJS.js
@@ -85,6 +85,11 @@ window.areTwins = function(slave1, slave2) {
 	return false;
 };
 
+/**
+ * @param {App.Entity.SlaveState} slave1
+ * @param {App.Entity.SlaveState} slave2
+ * @returns {number}
+ */
 window.areSisters = function(slave1, slave2) {
 	if (slave1.ID === slave2.ID) {
 		return 0; // you are not your own sister
@@ -239,7 +244,7 @@ window.randomRelatedSlave = function(slave, filterFunction) {
 /**
  * @param {App.Entity.SlaveState} slave
  * @param {function} filterFunction	// I think
- * @returns {object}	// I think
+ * @returns {App.Entity.SlaveState}
  */
 window.randomRelatedSlave = function(slave, filterFunction) {
 	if (!slave || !SugarCube) {
@@ -263,7 +268,7 @@ window.randomRelatedSlave = function(slave, filterFunction) {
 
 /**
  * @param {App.Entity.SlaveState} slave
- * @returns {object}
+ * @returns {App.Entity.SlaveState}
  */
 window.randomRelatedAvailableSlave = function(slave) {
 	return randomRelatedSlave(slave, function(s) {
@@ -273,7 +278,7 @@ window.randomRelatedAvailableSlave = function(slave) {
 
 /**
  * @param {App.Entity.SlaveState} slave
- * @returns {object}
+ * @returns {App.Entity.SlaveState}
  */
 window.randomSister = function(slave) {
 	return randomRelatedSlave(slave, function(s) {
@@ -283,7 +288,7 @@ window.randomSister = function(slave) {
 
 /**
  * @param {App.Entity.SlaveState} slave
- * @returns {object}
+ * @returns {App.Entity.SlaveState}
  */
 window.randomTwinSister = function(slave) {
 	return randomRelatedSlave(slave, function(s) {
@@ -293,7 +298,7 @@ window.randomTwinSister = function(slave) {
 
 /**
  * @param {App.Entity.SlaveState} slave
- * @returns {object}
+ * @returns {App.Entity.SlaveState}
  */
 window.randomAvailableSister = function(slave) {
 	return randomRelatedSlave(slave, function(s) {
@@ -303,7 +308,7 @@ window.randomAvailableSister = function(slave) {
 
 /**
  * @param {App.Entity.SlaveState} slave
- * @returns {object}
+ * @returns {App.Entity.SlaveState}
  */
 window.randomAvailableTwinSister = function(slave) {
 	return randomRelatedSlave(slave, function(s) {
@@ -313,7 +318,7 @@ window.randomAvailableTwinSister = function(slave) {
 
 /**
  * @param {App.Entity.SlaveState} slave
- * @returns {object}
+ * @returns {App.Entity.SlaveState}
  */
 window.randomDaughter = function(slave) {
 	return randomRelatedSlave(slave, function(s) {
@@ -323,7 +328,7 @@ window.randomDaughter = function(slave) {
 
 /**
  * @param {App.Entity.SlaveState} slave
- * @returns {object}
+ * @returns {App.Entity.SlaveState}
  */
 window.randomAvailableDaughter = function(slave) {
 	return randomRelatedSlave(slave, function(s) {
@@ -333,7 +338,7 @@ window.randomAvailableDaughter = function(slave) {
 
 /**
  * @param {App.Entity.SlaveState} slave
- * @returns {object}
+ * @returns {App.Entity.SlaveState}
  */
 window.randomParent = function(slave) {
 	return randomRelatedSlave(slave, function(s) {
@@ -343,7 +348,7 @@ window.randomParent = function(slave) {
 
 /**
  * @param {App.Entity.SlaveState} slave
- * @returns {object}
+ * @returns {App.Entity.SlaveState}
  */
 window.randomAvailableParent = function(slave) {
 	return randomRelatedSlave(slave, function(s) {
-- 
GitLab