From fe236ccf00814b67903f04e899b1e44d434ad6b1 Mon Sep 17 00:00:00 2001
From: lowercasedonkey <lowercasedonkey@gmail.com>
Date: Fri, 10 Jul 2020 22:12:02 -0400
Subject: [PATCH] jsdoc
---
js/003-data/slaveMods.js | 24 ++++++------------------
1 file changed, 6 insertions(+), 18 deletions(-)
diff --git a/js/003-data/slaveMods.js b/js/003-data/slaveMods.js
index 56b2e62ec75..0b1841003da 100644
--- a/js/003-data/slaveMods.js
+++ b/js/003-data/slaveMods.js
@@ -1,26 +1,14 @@
/**
- * @typedef {object} PolicySelector
- * @property {string} title The title of the policy as displayed in the UI, "Health Inspection SMR"
- * @property {string} [titleClass] The class to apply to the title: "lime"
- * @property {string} [activatedTitle] The title of the policy if the policy is active. Param "title" is used as a fallback.
- * @property {string} text Text that describes the policy in detail. No initial cap, ends with punctuation.
- * @property {string} [activatedText] Text that describes an active policy in detail. Uses param "text" as a fallback.
- * @property {function(void):boolean} [requirements] Function to determine if a policy can be enabled.
- * @property {function(void):void} [onImplementation] Beyond applying the policy itself and billing the player, are there other values to change? This allows a shortstack FS policy to revoke some generic tall policies, for example.
- * @property {function(void):void} [onRepeal] same as onImplementation, but fires when a policy is repealed.
- * @property {number|string} [enable] Value to enable a policy. Defaults to 1 if not defined.
- * @property {object} [hide] Object controlling special hide settings that can hide parts of the policy if needed.
- * @property {number} [hide.button] Hides the appeal/repeal button if 1
- * @property {number} [hide.ifActivated] Hides the entire policy if the policy is applied. 1 to enable.
- * @property {string} [note] Note that appears at the end of the policy display in italics to present further information. Starts with cap, no punctuation at end.
- * @property {string} [activatedNote] Note that appears if policy is activated. Please note that unlike the other "activated" categories, "note" is only displayed on deactivated policies. There is no fallback.
+ * @typedef {object} BrandStyle
+ * @property {string} displayName The way the brand is dispayed as a choice in the UI
+ * @property {function(void):boolean} [requirements] Function to determine if a brand symbol can be used.
*/
/**
- * @typedef {object<string, PolicySelector[]>} PolicySelectorGroup
- * Key names represent a piece of the variable. "policies.SMR.basicSMR" will be checked against "V.policies.SMR.basicSMR". "arcologies[0].FSEgyptianRevivalistIncestPolicy" will be checked against "V.arcologies[0].FSEgyptianRevivalistIncestPolicy".
+ * @typedef {object<string, BrandStyle[]>} BrandStyleList
+ * How the brand is saved in the variable.
*/
-/** @type {object<string, PolicySelectorGroup>} */
+/** @type {object<string, BrandStyleList>} */
App.Medicine.Modification.Brands = {
personal: {
"your personal symbol": {displayName: "Your slaving emblem"},
--
GitLab