JSDoc

src/js/pregJS.js

@@ -414,14 +414,15 @@ globalThis.setPregType = function(actor) {
 	return Math.ceil(ovum);
 };
 
-/*
- Penetrative ability, ability to become pregnant, and canBreed() must be checked outside of this. Designed to assume .eggType === "human".
- target is the slave to get pregnant. Also accepts the PC.
- chance is the % chance to conceive.
- hole control's the hole involved (0 - vagina, 1 - ass, 2 - both). .mpreg did this.
- fatherID is the ID of her sire or 0 if undefined.
- displayOverride is an override if defined - fatherID must be defined in this case.
-*/
+/** Attempt to get a slave pregnant
+ * Penetrative ability, ability to become pregnant, and canBreed() must be checked outside of this. Designed to assume .eggType === "human".
+ * @param {App.Entity.SlaveState} target is the slave to get pregnant. Also accepts the PC.
+ * @param {number} chance is the % chance to conceive.
+ * @param {number} hole control's the hole involved (0 - vagina, 1 - ass, 2 - both). .mpreg did this.
+ * @param {number} [fatherID] is the ID of her sire or 0 if undefined.
+ * @param {boolean} [displayOverride] is an override if defined - fatherID must be defined in this case.
+ * @returns {string}
+ */
 globalThis.knockMeUp = function(target, chance, hole, fatherID, displayOverride) {
 	let He;
 	let r = ``;