Skip to content

Commit 8387cec

Browse files
committed
jsdoc: Remove pointless @memberof lines, to remove typedoc warnings
Some of these were out of date due to classes having been renamed or code having been moved.
1 parent c8820e6 commit 8387cec

File tree

9 files changed

+0
-51
lines changed

9 files changed

+0
-51
lines changed

src/Config/Feature.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,6 @@ export class Feature {
3131
* @readonly
3232
* @static
3333
* @type {Feature[]}
34-
* @memberof Feature
3534
*/
3635
static get values(): Feature[] {
3736
let availableFeatures: Feature[] = [];
@@ -58,7 +57,6 @@ export class Feature {
5857
* @readonly
5958
* @static
6059
* @type {FeatureFlag}
61-
* @memberof Feature
6260
*/
6361
static get settingsFlags(): FeatureFlag {
6462
const featureFlags: { [internalName: string]: boolean } = {};

src/Config/SettingsTab.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -521,7 +521,6 @@ export class SettingsTab extends PluginSettingTab {
521521
*
522522
* @param {HTMLElement} containerEl
523523
* @param {SettingsTab} settings
524-
* @memberof SettingsTab
525524
*/
526525
insertTaskCoreStatusSettings(containerEl: HTMLElement, settings: SettingsTab) {
527526
const { statusSettings } = getSettings();
@@ -575,7 +574,6 @@ export class SettingsTab extends PluginSettingTab {
575574
*
576575
* @param {HTMLElement} containerEl
577576
* @param {SettingsTab} settings
578-
* @memberof SettingsTab
579577
*/
580578
insertCustomTaskStatusSettings(containerEl: HTMLElement, settings: SettingsTab) {
581579
const { statusSettings } = getSettings();

src/IQuery.ts

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ export interface IQuery {
1818
* the query to be used by a implementation of the IQuery.
1919
*
2020
* @type {string}
21-
* @memberof IQuery
2221
*/
2322
source: string;
2423

@@ -27,7 +26,6 @@ export interface IQuery {
2726
* the main task properties like backlink, heading, path, status, etc.
2827
*
2928
* @type {Grouper[]}
30-
* @memberof IQuery
3129
*/
3230
grouping: Grouper[];
3331

@@ -36,7 +34,6 @@ export interface IQuery {
3634
* shown to users.
3735
*
3836
* @type {(string | undefined)}
39-
* @memberof IQuery
4037
*/
4138
error: string | undefined;
4239

@@ -45,7 +42,6 @@ export interface IQuery {
4542
* used in the query.
4643
*
4744
* @type {TaskLayoutOptions}
48-
* @memberof IQuery
4945
*/
5046
taskLayoutOptions: TaskLayoutOptions;
5147

@@ -54,7 +50,6 @@ export interface IQuery {
5450
* used in the query.
5551
*
5652
* @type {QueryLayoutOptions}
57-
* @memberof IQuery
5853
*/
5954
queryLayoutOptions: QueryLayoutOptions;
6055

@@ -67,7 +62,6 @@ export interface IQuery {
6762
*
6863
* @param {Task[]} tasks
6964
* @return {*} {TaskGroups}
70-
* @memberof Query
7165
*/
7266
applyQueryToTasks: (tasks: Task[]) => QueryResult;
7367

src/Query/Query.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -386,7 +386,6 @@ ${statement.explainStatement(' ')}
386386
* @private
387387
* @param {number} length
388388
* @return {*} {string}
389-
* @memberof Query
390389
*/
391390
private generateQueryId(length: number): string {
392391
const chars = 'AaBbCcDdEeFfGgHhIiJjKkLlMmNnOoPpQqRrSsTtUuVvWwXxYyZz1234567890';

src/Statuses/Status.ts

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ export class Status {
2020
*
2121
* @static
2222
* @type {Status}
23-
* @memberof Status
2423
*/
2524
public static readonly DONE: Status = new Status(new StatusConfiguration('x', 'Done', ' ', true, StatusType.DONE));
2625

@@ -29,7 +28,6 @@ export class Status {
2928
*
3029
* @static
3130
* @type {Status}
32-
* @memberof Status
3331
*/
3432
public static readonly EMPTY: Status = new Status(new StatusConfiguration('', 'EMPTY', '', true, StatusType.EMPTY));
3533

@@ -39,7 +37,6 @@ export class Status {
3937
*
4038
* @static
4139
* @type {Status}
42-
* @memberof Status
4340
*/
4441
public static readonly TODO: Status = new Status(new StatusConfiguration(' ', 'Todo', 'x', true, StatusType.TODO));
4542

@@ -48,7 +45,6 @@ export class Status {
4845
*
4946
* @static
5047
* @type {Status}
51-
* @memberof Status
5248
*/
5349
public static readonly CANCELLED: Status = new Status(
5450
new StatusConfiguration('-', 'Cancelled', ' ', true, StatusType.CANCELLED),
@@ -59,7 +55,6 @@ export class Status {
5955
*
6056
* @static
6157
* @type {Status}
62-
* @memberof Status
6358
*/
6459
public static readonly IN_PROGRESS: Status = new Status(
6560
new StatusConfiguration('/', 'In Progress', 'x', true, StatusType.IN_PROGRESS),
@@ -70,7 +65,6 @@ export class Status {
7065
*
7166
* @static
7267
* @type {Status}
73-
* @memberof Status
7468
*/
7569
public static readonly NON_TASK: Status = new Status(
7670
new StatusConfiguration('Q', 'Non-Task', 'A', true, StatusType.NON_TASK),
@@ -80,15 +74,13 @@ export class Status {
8074
* The configuration stored in the data.json file.
8175
*
8276
* @type {StatusConfiguration}
83-
* @memberof Status
8477
*/
8578
public readonly configuration: StatusConfiguration;
8679

8780
/**
8881
* The symbol used between the two square brackets in the markdown task.
8982
*
9083
* @type {string}
91-
* @memberof Status
9284
*/
9385
public get symbol(): string {
9486
return this.configuration.symbol;
@@ -98,7 +90,6 @@ export class Status {
9890
* Returns the name of the status for display purposes.
9991
*
10092
* @type {string}
101-
* @memberof Status
10293
*/
10394
public get name(): string {
10495
return this.configuration.name;
@@ -108,7 +99,6 @@ export class Status {
10899
* Returns the next status for a task when toggled.
109100
*
110101
* @type {string}
111-
* @memberof Status
112102
* @see nextSymbol
113103
*/
114104
public get nextStatusSymbol(): string {
@@ -120,7 +110,6 @@ export class Status {
120110
* This is an alias for {@link nextStatusSymbol} which is provided for brevity in user scripts.
121111
*
122112
* @type {string}
123-
* @memberof Status
124113
* @see nextStatusSymbol
125114
*/
126115
public get nextSymbol(): string {
@@ -131,7 +120,6 @@ export class Status {
131120
* If true then it is registered as a command that the user can map to.
132121
*
133122
* @type {boolean}
134-
* @memberof Status
135123
*/
136124
public get availableAsCommand(): boolean {
137125
return this.configuration.availableAsCommand;
@@ -184,7 +172,6 @@ export class Status {
184172
* of the default statuses.
185173
*
186174
* @param {StatusConfiguration} configuration
187-
* @memberof Status
188175
*/
189176
constructor(configuration: StatusConfiguration) {
190177
this.configuration = configuration;
@@ -251,7 +238,6 @@ export class Status {
251238
* when the task is done/x.
252239
*
253240
* @return {*} {boolean}
254-
* @memberof Status
255241
*/
256242
public isCompleted(): boolean {
257243
return this.type === StatusType.DONE;

src/Statuses/StatusConfiguration.ts

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,31 +22,27 @@ export class StatusConfiguration {
2222
* The character used between the two square brackets in the markdown task.
2323
*
2424
* @type {string}
25-
* @memberof Status
2625
*/
2726
public readonly symbol: string;
2827

2928
/**
3029
* Returns the name of the status for display purposes.
3130
*
3231
* @type {string}
33-
* @memberof Status
3432
*/
3533
public readonly name: string;
3634

3735
/**
3836
* Returns the next status for a task when toggled.
3937
*
4038
* @type {string}
41-
* @memberof Status
4239
*/
4340
public readonly nextStatusSymbol: string;
4441

4542
/**
4643
* If true then it is registered as a command that the user can map to.
4744
*
4845
* @type {boolean}
49-
* @memberof Status
5046
*/
5147
public readonly availableAsCommand: boolean;
5248

@@ -64,7 +60,6 @@ export class StatusConfiguration {
6460
* @param {Status} nextStatusSymbol
6561
* @param {boolean} availableAsCommand
6662
* @param {StatusType} type
67-
* @memberof Status
6863
*/
6964
constructor(
7065
symbol: string,

src/Statuses/StatusRegistry.ts

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,6 @@ export class StatusRegistry {
3030
* Code in the plugin should use {@link getInstance} to use and modify the global
3131
* StatusRegistry.
3232
*
33-
* @memberof StatusRegistry
3433
*/
3534
public constructor() {
3635
this.addDefaultStatusTypes();
@@ -54,7 +53,6 @@ export class StatusRegistry {
5453
*
5554
* @readonly
5655
* @type {Status[]}
57-
* @memberof StatusRegistry
5856
*/
5957
public get registeredStatuses(): Status[] {
6058
return this._registeredStatuses.filter(({ symbol }) => symbol !== Status.EMPTY.symbol);
@@ -65,7 +63,6 @@ export class StatusRegistry {
6563
*
6664
* @static
6765
* @return {*} {StatusRegistry}
68-
* @memberof StatusRegistry
6966
*/
7067
public static getInstance(): StatusRegistry {
7168
if (!StatusRegistry.instance) {
@@ -79,7 +76,6 @@ export class StatusRegistry {
7976
* Adds a new Status to the registry if not already registered.
8077
*
8178
* @param {StatusConfiguration | Status} status
82-
* @memberof StatusRegistry
8379
*/
8480
public add(status: StatusConfiguration | Status): void {
8581
if (!this.hasSymbol(status.symbol)) {
@@ -100,7 +96,6 @@ export class StatusRegistry {
10096
*
10197
* @param {string} symbol
10298
* @return {*} {Status}
103-
* @memberof StatusRegistry
10499
*/
105100
public bySymbol(symbol: string): Status {
106101
if (this.hasSymbol(symbol)) {
@@ -121,7 +116,6 @@ export class StatusRegistry {
121116
*
122117
* @param {string} symbol
123118
* @return {*} {Status}
124-
* @memberof StatusRegistry
125119
*/
126120
public bySymbolOrCreate(symbol: string): Status {
127121
if (this.hasSymbol(symbol)) {
@@ -136,7 +130,6 @@ export class StatusRegistry {
136130
*
137131
* @param {string} nameToFind
138132
* @return {*} {Status}
139-
* @memberof StatusRegistry
140133
*/
141134
public byName(nameToFind: string): Status {
142135
if (this._registeredStatuses.filter(({ name }) => name === nameToFind).length > 0) {
@@ -149,7 +142,6 @@ export class StatusRegistry {
149142
/**
150143
* Resets the array of Status types to the default statuses.
151144
*
152-
* @memberof StatusRegistry
153145
*/
154146
public resetToDefaultStatuses(): void {
155147
this.clearStatuses();
@@ -168,7 +160,6 @@ export class StatusRegistry {
168160
* which status can come after it as a state transition.
169161
*
170162
* @return {*} {Status}
171-
* @memberof StatusRegistry
172163
* @see getNextStatusOrCreate
173164
*/
174165
public getNextStatus(status: Status): Status {
@@ -186,7 +177,6 @@ export class StatusRegistry {
186177
* TODO status using the requested next symbol.
187178
*
188179
* @return {*} {Status}
189-
* @memberof StatusRegistry
190180
* @see getNextStatus
191181
*/
192182
public getNextStatusOrCreate(status: Status): Status {
@@ -304,7 +294,6 @@ export class StatusRegistry {
304294
* @private
305295
* @param {string} symbolToFind
306296
* @return {*} {Status}
307-
* @memberof StatusRegistry
308297
*/
309298
private getSymbol(symbolToFind: string): Status {
310299
return this._registeredStatuses.filter(({ symbol }) => symbol === symbolToFind)[0];
@@ -316,7 +305,6 @@ export class StatusRegistry {
316305
* @private
317306
* @param {string} symbolToFind
318307
* @return {*} {boolean}
319-
* @memberof StatusRegistry
320308
*/
321309
private hasSymbol(symbolToFind: string): boolean {
322310
return (
@@ -330,7 +318,6 @@ export class StatusRegistry {
330318
* Checks the registry and adds the default status types.
331319
*
332320
* @private
333-
* @memberof StatusRegistry
334321
*/
335322
private addDefaultStatusTypes(): void {
336323
const defaultStatuses = [Status.TODO, Status.IN_PROGRESS, Status.DONE, Status.CANCELLED];

src/Task/Task.ts

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,6 @@ export class Task extends ListItem {
165165
* @param {TaskLocation} taskLocation - The location of the task line
166166
* @param {(Moment | null)} fallbackDate - The date to use as the scheduled date if no other date is set
167167
* @return {*} {(Task | null)}
168-
* @memberof Task
169168
* @see parseTaskSignifiers
170169
*/
171170
public static fromLine({
@@ -280,7 +279,6 @@ export class Task extends ListItem {
280279
*
281280
* @note Output depends on {@link Settings.taskFormat}
282281
* @return {*} {string}
283-
* @memberof Task
284282
*/
285283
public toString(): string {
286284
return getUserSelectedTaskFormat().taskSerializer.serialize(this);
@@ -291,7 +289,6 @@ export class Task extends ListItem {
291289
*
292290
* @note Output depends on {@link Settings.taskFormat}
293291
* @return {*} {string}
294-
* @memberof Task
295292
*/
296293
public toFileLineString(): string {
297294
return `${this.indentation}${this.listMarker} [${this.status.symbol}] ${this.toString()}`;

0 commit comments

Comments
 (0)