Skip to content

Commit 311423a

Browse files
patrickmohrmannpatrickmohrmann
authored
Merge pull request #3798 from earthdawn-vtt/chore/1675-refactoring-replace-all-override-with-inheritdoc
📝 Replace @OverRide with @inheritdoc
2 parents 7a09fbf + 7507cc6 commit 311423a

14 files changed

Lines changed: 30 additions & 30 deletions

‎module/applications/actor/character-sheet.mjs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ export default class ActorSheetEdCharacter extends ActorSheetEdNamegiver {
1010

1111
// region Static Properties
1212

13-
/** @override */
13+
/** @inheritdoc */
1414
static DEFAULT_OPTIONS = {
1515
id: "character-sheet-{id}",
1616
uniqueId: String( ++foundry.applications.api.ApplicationV2._appId ),

‎module/applications/components/checkbox.mjs‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ export default class CheckboxElement extends AdoptedStyleSheetMixin(
1818

1919
/* -------------------------------------------- */
2020

21-
/** @override */
21+
/** @inheritdoc */
2222
static tagName = "dnd5e-checkbox";
2323

2424
/* -------------------------------------------- */
@@ -30,7 +30,7 @@ export default class CheckboxElement extends AdoptedStyleSheetMixin(
3030

3131
/* -------------------------------------------- */
3232

33-
/** @override */
33+
/** @inheritdoc */
3434
static CSS = `
3535
:host {
3636
cursor: var(--cursor-pointer);
@@ -135,21 +135,21 @@ export default class CheckboxElement extends AdoptedStyleSheetMixin(
135135

136136
/* -------------------------------------------- */
137137

138-
/** @override */
138+
/** @inheritdoc */
139139
get value() {
140140
return super.value;
141141
}
142142

143143
/**
144144
* Override AbstractFormInputElement#value setter because we want to emit input/change events when the checked state
145145
* changes, and not when the value changes.
146-
* @override
146+
* @inheritdoc
147147
*/
148148
set value( value ) {
149149
this._setValue( value );
150150
}
151151

152-
/** @override */
152+
/** @inheritdoc */
153153
_getValue() {
154154
// Workaround for FormElementExtended only checking the value property and not the checked property.
155155
if ( typeof this._value === "string" ) return this._value;
@@ -160,7 +160,7 @@ export default class CheckboxElement extends AdoptedStyleSheetMixin(
160160
/* Element Lifecycle */
161161
/* -------------------------------------------- */
162162

163-
/** @override */
163+
/** @inheritdoc */
164164
connectedCallback() {
165165
this._adoptStyleSheet( this._getStyleSheet() );
166166
const elements = this._buildElements();
@@ -172,21 +172,21 @@ export default class CheckboxElement extends AdoptedStyleSheetMixin(
172172

173173
/* -------------------------------------------- */
174174

175-
/** @override */
175+
/** @inheritdoc */
176176
disconnectedCallback() {
177177
this._controller.abort();
178178
}
179179

180180
/* -------------------------------------------- */
181181

182-
/** @override */
182+
/** @inheritdoc */
183183
_adoptStyleSheet( sheet ) {
184184
this.#shadowRoot.adoptedStyleSheets = [ sheet ];
185185
}
186186

187187
/* -------------------------------------------- */
188188

189-
/** @override */
189+
/** @inheritdoc */
190190
_buildElements() {
191191
const container = document.createElement( "div" );
192192
container.innerHTML = `
@@ -217,7 +217,7 @@ export default class CheckboxElement extends AdoptedStyleSheetMixin(
217217

218218
/* -------------------------------------------- */
219219

220-
/** @override */
220+
/** @inheritdoc */
221221
_activateListeners() {
222222
const { signal } = this._controller = new AbortController();
223223
this.addEventListener( "click", this._onClick.bind( this ), { signal } );
@@ -226,15 +226,15 @@ export default class CheckboxElement extends AdoptedStyleSheetMixin(
226226

227227
/* -------------------------------------------- */
228228

229-
/** @override */
229+
/** @inheritdoc */
230230
_refresh() {
231231
super._refresh();
232232
this._internals.ariaChecked = `${this.hasAttribute( "checked" )}`;
233233
}
234234

235235
/* -------------------------------------------- */
236236

237-
/** @override */
237+
/** @inheritdoc */
238238
_onClick( event ) {
239239
event.preventDefault();
240240
this.checked = !this.checked;

‎module/applications/components/slide-toggle.mjs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@ export default class SlideToggleElement extends CheckboxElement {
1313

1414
/* -------------------------------------------- */
1515

16-
/** @override */
16+
/** @inheritdoc */
1717
static tagName = "slide-toggle";
1818

1919
/* -------------------------------------------- */
2020

21-
/** @override */
21+
/** @inheritdoc */
2222
static useShadowRoot = false;
2323

2424
/* -------------------------------------------- */

‎module/applications/scene/scene-config.mjs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ export default class SceneConfigEd extends foundry.applications.sheets.SceneConf
1515
footer: { ...super.PARTS.footer },
1616
};
1717

18-
/** @override */
18+
/** @inheritdoc */
1919
static TABS = {
2020
...super.TABS,
2121
sheet: {
@@ -27,7 +27,7 @@ export default class SceneConfigEd extends foundry.applications.sheets.SceneConf
2727
},
2828
};
2929

30-
/** @override */
30+
/** @inheritdoc */
3131
async _onRender( context, options ) {
3232
await super._onRender( context, options );
3333
this._addAstralPollutionToScene( context, options );

‎module/data/abstract/actor-data-model.mjs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ export default class ActorDataModel extends SystemDataModel {
2727
/* Properties */
2828
/* -------------------------------------------- */
2929

30-
/** @override */
30+
/** @inheritdoc */
3131
get embeddedDescriptionKeyPath() {
3232
return "description.value";
3333
}

‎module/data/abstract/item-data-model.mjs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ export default class ItemDataModel extends SystemDataModel {
4545

4646
// region Getters
4747

48-
/** @override */
48+
/** @inheritdoc */
4949
get embeddedDescriptionKeyPath() {
5050
return game.user.isGM || ( this.identified !== false ) ? "description.value" : "unidentified.description";
5151
}

‎module/data/abstract/system-data-model.mjs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -415,7 +415,7 @@ export default class SystemDataModel extends foundry.abstract.TypeDataModel {
415415

416416
// region Methods
417417

418-
/** @override */
418+
/** @inheritdoc */
419419
async toEmbed( config, options={} ) {
420420
const keyPath = this.embeddedDescriptionKeyPath;
421421
if ( !keyPath || !foundry.utils.hasProperty( this, keyPath ) ) return null;

‎module/data/fields/identifier-field.mjs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ export default class IdentifierField extends foundry.data.fields.StringField {
1717
// endregion
1818

1919
/**
20-
* @override
20+
* @inheritdoc
2121
*/
2222
_validateType( value ) {
2323
if ( !this.constructor.isValidIdentifier( value ) ) {

‎module/data/item/weapon.mjs‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@ export default class WeaponData extends PhysicalItemTemplate.mixin(
176176

177177
// region Getters
178178

179-
/** @override */
179+
/** @inheritdoc */
180180
get ammoAmount() {
181181
if ( !this.isRanged ) return null;
182182
if ( this.isActorEmbedded ) {
@@ -201,7 +201,7 @@ export default class WeaponData extends PhysicalItemTemplate.mixin(
201201
);
202202
}
203203

204-
/** @override */
204+
/** @inheritdoc */
205205
get damageTotal() {
206206
if ( this.isActorEmbedded ) {
207207
const damageAttribute = this.damage.attribute;
@@ -237,7 +237,7 @@ export default class WeaponData extends PhysicalItemTemplate.mixin(
237237
return false;
238238
}
239239

240-
/** @override */
240+
/** @inheritdoc */
241241
get nextItemStatus() {
242242
const namegiver = this.parent.parent?.namegiver;
243243
const weaponSizeLimits = namegiver?.system.weaponSize;
@@ -247,7 +247,7 @@ export default class WeaponData extends PhysicalItemTemplate.mixin(
247247
return this._rotateValidItemStatus( this.statusIndex, false );
248248
}
249249

250-
/** @override */
250+
/** @inheritdoc */
251251
get previousItemStatus() {
252252
const namegiver = this.parent.parent?.namegiver;
253253
const weaponSizeLimits = namegiver?.system.weaponSize;

‎module/data/roll/warping.mjs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ export default class WarpingRollOptions extends EdRollOptions {
7474

7575
/**
7676
* This method is not applicable for warping rolls and will throw an error if called.
77-
* @override
77+
* @inheritdoc
7878
* @throws Error Warping rolls do not use rolling actors. Use {@link WarpingRollOptions~fromData} instead, and supply the target as `caster` or `casterUuid` in the data.
7979
*/
8080
static fromActor( data, actor, options = {} ) {

0 commit comments

Comments
 (0)