update dependencies and devDependencies, fix lint issues

[websub-hub] / src / template / root-html.js

diff --git a/src/template/root-html.js b/src/template/root-html.js
index 9496c7e8a3a5a666d5be34591380760bb35f81a4..d035bb8c342da6ca94b3f93fd4f25cfcb1398a4d 100644 (file)
--- a/src/template/root-html.js
+++ b/src/template/root-html.js
@@ -2,6 +2,12 @@
 
 const th = require('./template-helper');
 
+/**
+ *
+ * @param {string} pageTitle page title
+ * @param {string} logoUrl logo url
+ * @returns {string} element
+ */
 function hAppSection(pageTitle, logoUrl) {
   return `      <section hidden class="h-app">
         <h2>h-app Information for IndieAuth Logins</h2>
@@ -14,6 +20,9 @@ function hAppSection(pageTitle, logoUrl) {
       </section>`;
 }
 
+/**
+ * @returns {string} element
+ */
 function aboutSection() {
   return `      <section class="about">
         <h2>What</h2>
@@ -29,6 +38,12 @@ function aboutSection() {
       </section>`;
 }
 
+/**
+ *
+ * @param {boolean} isPublicHub is public hub
+ * @param {string} hubURL hub url
+ * @returns {string} html
+ */
 function usageSection(isPublicHub, hubURL) {
   const usageContent = isPublicHub ? `      <h2>Public Hub</h2>
       <p>
@@ -121,6 +136,11 @@ ${usageContent}
       </section>`;
 }
 
+/**
+ *
+ * @param {string} contactHTML html
+ * @returns {string} html
+ */
 function contactSection(contactHTML) {
   let section = '';
   if (contactHTML) {
@@ -133,15 +153,15 @@ ${contactHTML}
 
 /**
  * 
- * @param {Object} ctx
- * @param {Object} options
- * @param {Object} options.manager
- * @param {String} options.adminContactHTML
- * @param {String} options.manager.pageTitle
- * @param {String} options.manager.publicHub
- * @param {Object} options.dingus
- * @param {String} options.dingus.selfBaseUrl
- * @returns {String}
+ * @param {object} ctx context
+ * @param {object} options options
+ * @param {object} options.manager manager options
+ * @param {string} options.adminContactHTML html
+ * @param {string} options.manager.pageTitle title
+ * @param {string} options.manager.publicHub is public
+ * @param {object} options.dingus dingus options
+ * @param {string} options.dingus.selfBaseUrl url
+ * @returns {string} html
  */
 module.exports = (ctx, options) => {
   const pageTitle = options.manager.pageTitle;