oliverbooth/oliverbooth.dev
oliverbooth/oliverbooth.dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Activity

docs: add @param to UI methods

Browse Source
This commit is contained in:
Oliver Booth 2023-08-10 16:18:52 +01:00
parent ab5277bacb
commit b4c991e44f
Signed by: oliverbooth
GPG Key ID: 725DB725A0D9EE61
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/ts/UI.ts
View File

@ -1,4 +1,4 @@
import BlogPost from "./BlogPost"; import BlogPost from "./BlogPost";
import Author from "./Author"; import Author from "./Author";
import TimeUtility from "./TimeUtility"; import TimeUtility from "./TimeUtility";
@ -63,6 +63,7 @@ class UI {
/** /**
* Forces all UI elements under the given element to update their rendering. * 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) { public static updateUI(element?: Element) {
element = element || document.body; element = element || document.body;
@ -75,6 +76,7 @@ class UI {
/** /**
* Adds Bootstrap tooltips to all elements with a title attribute. * 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) { public static addBootstrapTooltips(element?: Element) {
element = element || document.body; element = element || document.body;
@ -90,6 +92,7 @@ class UI {
/** /**
* Adds line numbers to all <pre> <code> blocks that have more than one line. * Adds line numbers to all <pre> <code> blocks that have more than one line.
* @param element The element to search for <pre> <code> blocks in.
*/ */
public static addLineNumbers(element?: Element) { public static addLineNumbers(element?: Element) {
element = element || document.body; element = element || document.body;
@ -114,6 +117,7 @@ class UI {
/** /**
* Renders all TeX in the document. * Renders all TeX in the document.
* @param element The element to search for TeX in.
*/ */
public static renderTeX(element?: Element) { public static renderTeX(element?: Element) {
element = element || document.body; element = element || document.body;
@ -129,6 +133,7 @@ class UI {
/** /**
* Unescapes all <mark> tags in <pre> <code> blocks. * Unescapes all <mark> tags in <pre> <code> blocks.
* @param element The element to search for <pre> <code> blocks in.
*/ */
public static unescapeMarkTags(element?: Element) { public static unescapeMarkTags(element?: Element) {
element = element || document.body; element = element || document.body;