From 236f25bc8645156dae9d3ae05d62c6481a23510b Mon Sep 17 00:00:00 2001
From: lowercasedonkey <lowercasedonkey@gmail.com>
Date: Mon, 3 Aug 2020 20:53:58 -0400
Subject: [PATCH] jsdoc
---
src/pregmod/FCTV/FCTV.js | 2 ++
src/pregmod/FCTV/FCTVshows.js | 20 ++++++--------------
2 files changed, 8 insertions(+), 14 deletions(-)
diff --git a/src/pregmod/FCTV/FCTV.js b/src/pregmod/FCTV/FCTV.js
index 69f1c6a574e..d006274c95c 100644
--- a/src/pregmod/FCTV/FCTV.js
+++ b/src/pregmod/FCTV/FCTV.js
@@ -381,6 +381,7 @@ globalThis.FctvDisplay = function({usedRemote = 0, seeAll = 0} = {}) {
function getEpisode(sel) {
let epToShow = -1;
const epsArray = [];
+ /** @type {FctvChannel} */
const channel = App.Data.FCTV.channels[sel];
const viewedCount = V.FCTV.channel[num(sel, true)];
for (let i = 0; i < App.Data.FCTV.channels[sel].episode.length; i++) {
@@ -416,6 +417,7 @@ globalThis.FctvDisplay = function({usedRemote = 0, seeAll = 0} = {}) {
function displayShow() {
const frag = new DocumentFragment();
const sel = V.FCTV.channel.selected;
+ /** @type {FctvChannel} */
const channel = App.Data.FCTV.channels[sel];
const epToShow = getEpisode(sel);
if (epToShow === -1) {
diff --git a/src/pregmod/FCTV/FCTVshows.js b/src/pregmod/FCTV/FCTVshows.js
index d8571890be1..86b553d1aca 100644
--- a/src/pregmod/FCTV/FCTVshows.js
+++ b/src/pregmod/FCTV/FCTVshows.js
@@ -1,13 +1,8 @@
/**
* @typedef {object<string, App.Entity.SlaveState>} FctvActor
- * @property {string} slave name
*/
-/**
- * @typedef {object<string, FctvActor[]>} FctvActors
- */
-
-/** @type {object<string, FctvActor>} */
+/** @type {object.<string, FctvActor>} */
App.Data.FCTV.actors = {
get millie() {
const slave = BaseSlave();
@@ -519,23 +514,19 @@ App.Data.FCTV.actors = {
}
};
-/**
- * @typedef {object<string, FctvChannel[]>} FctvChannels
- */
-
/**
* @typedef {object} FctvChannel
* @property {FctvTags} [tags]
* @property {boolean} loop After an initial viewing, should the episodes continue to play in order?
* @property {string} intro
- * @property {array<FctvEpisode[]>} episode
- * @property {Function(App.Entity.SlaveState):string} outro
+ * @property {FctvEpisode[]} episode
+ * @property {function(App.Entity.SlaveState, [number]):string} outro Takes slave and episode number
*/
/**
* @typedef {object} FctvEpisode
- * @property {FctvTags[]} [tags]
- * @property {array<App.Entity.SlaveState>} [slaves]
+ * @property {FctvTags} [tags]
+ * @property {App.Entity.SlaveState[]} [slaves]
* @property {string} text HTML embedded
*/
@@ -548,6 +539,7 @@ App.Data.FCTV.actors = {
* @property {boolean} [dicks]
*/
+/** @type {object.<number, FctvChannel>} */
App.Data.FCTV.channels = {
0: { // News
tags: {},
--
GitLab