From 283f6dd8132eeec25632ec318c90f70bc90c1d12 Mon Sep 17 00:00:00 2001
From: Skriv <skrivelese@gmail.com>
Date: Tue, 18 Jun 2019 20:47:54 +0200
Subject: [PATCH] improve jsdoc for SlaveArt
---
src/art/artJS.js | 17 +++++++----------
1 file changed, 7 insertions(+), 10 deletions(-)
diff --git a/src/art/artJS.js b/src/art/artJS.js
index fc7a433f116..79b2227aa90 100644
--- a/src/art/artJS.js
+++ b/src/art/artJS.js
@@ -2,16 +2,13 @@
/* eslint-disable no-undef */
/**
* Call as <<= SlaveArt(...)>> or <<print SlaveArt(...)>>Displays slave images. Currently passage-based.
- * artSlave: Slave.
- * artSize: Image size/center.
- * 3: Large, right. Example: long slave description.
- * 2: Medium, right. Example: random events.
- * 1: Small, left. Example: lists.
- * 0: Tiny, left. Example: facilities
- * UIDisplay (optional, only used by legacy art): icon UI Display for vector art, 1 for on.
- * @param {App.Entity.SlaveState} artSlave
- * @param {number} artSize
- * @param {number} UIDisplay
+ * @param {App.Entity.SlaveState} artSlave Slave
+ * @param {number} artSize Image size/center:
+ * * 3: Large, right. Example: long slave description.
+ * * 2: Medium, right. Example: random events.
+ * * 1: Small, left. Example: lists.
+ * * 0: Tiny, left. Example: facilities
+ * @param {number} [UIDisplay] (optional, only used by legacy art): icon UI Display for vector art, 1 for on
* @returns {string}
*/
window.SlaveArt = function(artSlave, artSize, UIDisplay) {
--
GitLab