Skip to content

Commit 4797bfd

Browse files
committed
Documentation pass
1 parent c131a2d commit 4797bfd

File tree

3 files changed

+7
-5
lines changed

3 files changed

+7
-5
lines changed

jsdoc.config.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ module.exports = {
66
"include": [
77
"src",
88
"src/plugins",
9+
"src/fieldset",
910
"README.md"
1011
],
1112
}

src/error-handling-element.js

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,11 @@ import {
99
} from './element-utilities.js'
1010

1111
/**
12+
* @class
13+
* @classdesc
1214
* A Custom Element class that can be subclassed, allowing you to customize
1315
* how error handling works in your client-side code.
1416
*
15-
* @class
1617
*
1718
* @example
1819
*
@@ -42,14 +43,14 @@ export class ErrorHandlingElement extends HTMLElement {
4243
/**
4344
* Prepares the custom element to be connected to the page.
4445
*
45-
* Attaches the following event handlers to the `form`:
46+
* Attaches the following event handlers to the {@link ErrorHandlingElement#form}:
4647
* - {@link liveInputValidationEventHandler}
4748
* - {@link focusoutValidationEventHandler}
4849
* - {@link validateFormSubmitEventHandler}
4950
*
5051
* Calls {@link reflectConstraintValidationForInitialLoad}
5152
*
52-
* Sets the `novalidate` attribute on the `form`
53+
* Sets the `novalidate` attribute on the {@link ErrorHandlingElement#form}
5354
*/
5455
connectedCallback() {
5556
if(!this.isConnected){ return }

src/rendering.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ import {
1212
/**
1313
* Renders the error list for the given `element` based on the Constraint Validation API state.
1414
*
15-
* If the `element` is valid, calls {@link clearErrorList }.
16-
* Otherwise calls {@link renderErrorMessageListItem} for the {@link generateValidationMessage} and replaces the
15+
* calls {@link clearErrorList }.
16+
* calls {@link renderErrorMessageListItem} for the {@link generateValidationMessage} and replaces the
1717
* error list to include that message (marked as `data-visible`) and any `preserved` errors
1818
*
1919
* @param {Element} element

0 commit comments

Comments
 (0)