From b4c991e44f70395d38d0a00dfdf2486d11fa16c6 Mon Sep 17 00:00:00 2001 From: Oliver Booth Date: Thu, 10 Aug 2023 16:18:52 +0100 Subject: [PATCH] docs: add @param to UI methods --- src/ts/UI.ts | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/src/ts/UI.ts b/src/ts/UI.ts index 6da207e..1bca4ed 100644 --- a/src/ts/UI.ts +++ b/src/ts/UI.ts @@ -1,4 +1,4 @@ -import BlogPost from "./BlogPost"; +import BlogPost from "./BlogPost"; import Author from "./Author"; import TimeUtility from "./TimeUtility"; @@ -63,6 +63,7 @@ class UI { /** * Forces all UI elements under the given element to update their rendering. + * @param element The element to search for UI elements in. */ public static updateUI(element?: Element) { element = element || document.body; @@ -75,6 +76,7 @@ class UI { /** * Adds Bootstrap tooltips to all elements with a title attribute. + * @param element The element to search for elements with a title attribute in. */ public static addBootstrapTooltips(element?: Element) { element = element || document.body; @@ -90,6 +92,7 @@ class UI { /** * Adds line numbers to all
  blocks that have more than one line.
+     * @param element The element to search for 
  blocks in.
      */
     public static addLineNumbers(element?: Element) {
         element = element || document.body;
@@ -114,6 +117,7 @@ class UI {
 
     /**
      * Renders all TeX in the document.
+     * @param element The element to search for TeX in.
      */
     public static renderTeX(element?: Element) {
         element = element || document.body;
@@ -129,6 +133,7 @@ class UI {
 
     /**
      * Unescapes all  tags in 
  blocks.
+     * @param element The element to search for 
  blocks in.
      */
     public static unescapeMarkTags(element?: Element) {
         element = element || document.body;