Tidy up JSDoc comments
This commit is contained in:
parent
a02cc85b7f
commit
3702767a44
11
DjlLipsum.js
11
DjlLipsum.js
|
@ -1,12 +1,11 @@
|
|||
/**
|
||||
*
|
||||
* @property {string} baseText Text that textContent will be based on.
|
||||
* @property {number | undefined} length Length of text to be displayed (in characters).
|
||||
* If wrap is false, this is inferred as maximum length.
|
||||
* @property {boolean} randomStart Whether baseText should pick a random word to start on.
|
||||
* @property {boolean} wrap Whether baseText should return to the start if the length
|
||||
* @property {string} baseText - Text that textContent will be based on.
|
||||
* @property {number | undefined} length - Length of text to be displayed (in characters). If wrap is false, this is inferred as maximum length.
|
||||
* @property {boolean} randomStart - Whether baseText should pick a random word to start on.
|
||||
* @property {boolean} wrap - Whether baseText should return to the start if the length
|
||||
* condition hasn't been satisfied.
|
||||
* @property {string} lipsum Lorem Ipsum text. Used as a fallback if no user supplied
|
||||
* @property {string} lipsum - Lorem Ipsum text. Used as a fallback if no user supplied
|
||||
* text.
|
||||
*/
|
||||
class DjlLipsum extends HTMLElement {
|
||||
|
|
10
DjlScript.js
10
DjlScript.js
|
@ -1,11 +1,11 @@
|
|||
/**
|
||||
* Inline, editable code tag.
|
||||
* Executed and rendered as <cod\> initially; on click displays an <input> of the
|
||||
* Executed and rendered as <code> initially; on click displays an <input> of the
|
||||
* JavaScript. On submit re-executes and renders <code>.
|
||||
* @property {HTMLElement} code HTML Code element.
|
||||
* @property {HTMLFormElement} form HTML Form element.
|
||||
* @property {HTMLInputElement} input HTML Input element.
|
||||
* @property {string} sourceCode User input source code.
|
||||
* @property {HTMLElement} code - HTML Code element.
|
||||
* @property {HTMLFormElement} form - HTML Form element.
|
||||
* @property {HTMLInputElement} input - HTML Input element.
|
||||
* @property {string} sourceCode - User input source code.
|
||||
*/
|
||||
class DjlScript extends HTMLElement {
|
||||
code; // HTMLElement
|
||||
|
|
Loading…
Reference in New Issue