Skip to content

Commit 165fa24

Browse files
committed
jsdoc: Remove @export and @exports lines, to remove typedoc warnings
1 parent 8387cec commit 165fa24

File tree

11 files changed

+0
-20
lines changed

11 files changed

+0
-20
lines changed

src/Config/GlobalQuery.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ import type { OptionalTasksFile } from '../Scripting/TasksFile';
1111
* They should use `new GlobalQuery()`, which makes simpler, more readable
1212
* tests that can be run in parallel.
1313
*
14-
* @export
1514
* @class GlobalQuery
1615
*/
1716
export class GlobalQuery {

src/Config/Settings.ts

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,6 @@ function addNewOptionsToUserSettings<KeysAndValues>(defaultValues: KeysAndValues
159159
* update the flags to make sure they are all shown in the data.json
160160
* file. Exposure via the settings UI is optional.
161161
*
162-
* @export
163162
* @returns true if the feature is enabled.
164163
*/
165164
export const getSettings = (): Settings => {
@@ -214,7 +213,6 @@ export const updateGeneralSetting = (name: string, value: string | boolean): Set
214213
/**
215214
* Returns the enabled state of the feature from settings.
216215
*
217-
* @export
218216
* @param internalName the internal name of the feature.
219217
* @returns true if the feature is enabled.
220218
*/
@@ -225,7 +223,6 @@ export const isFeatureEnabled = (internalName: string): boolean => {
225223
/**
226224
* enables toggling the feature and returning the current collection with state.
227225
*
228-
* @export
229226
* @param internalName the internal name of the feature.
230227
* @param enabled the expected state of the feature.
231228
* @returns the features with the specified feature toggled.
@@ -238,7 +235,6 @@ export const toggleFeature = (internalName: string, enabled: boolean): FeatureFl
238235
/**
239236
* Retrieves the {@link TaskFormat} that corresponds to user's selection ({@link Settings.taskFormat})
240237
*
241-
* @exports
242238
* @returns {TaskFormat}
243239
*/
244240
export function getUserSelectedTaskFormat(): TaskFormat {

src/IQuery.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ import type { QueryResult } from './Query/QueryResult';
99
* engines can be created by using this and then updating the
1010
* Query Render class to handle the syntax for the new query engine.
1111
*
12-
* @export
1312
* @interface IQuery
1413
*/
1514
export interface IQuery {

src/Statuses/Status.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ import type { StatusCollectionEntry } from './StatusCollection';
1111
* @see StatusSettingsHelpers.ts
1212
* @see CustomStatusModal
1313
*
14-
* @export
1514
* @class Status
1615
*/
1716
export class Status {

src/Statuses/StatusConfiguration.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ export enum StatusType {
1414
* This is the object stored by the Obsidian configuration and used to create the status
1515
* objects for the session
1616
*
17-
* @export
1817
* @class StatusConfiguration
1918
*/
2019
export class StatusConfiguration {

src/Statuses/StatusRegistry.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ import { StatusConfiguration, StatusType } from './StatusConfiguration';
1515
* They should use `new StatusRegistry()`, which makes for simpler, more readable
1616
* tests that can be run in parallel.
1717
*
18-
* @export
1918
* @class StatusRegistry
2019
*/
2120
export class StatusRegistry {

src/Task/Priority.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@
66
* - {@link priorityNameUsingNone} in {@link PriorityTools}
77
* - {@link priorityNameUsingNormal} in {@link PriorityTools}
88
*
9-
* @export
109
* @enum {number}
1110
*/
1211
export enum Priority {

src/Task/Task.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,6 @@ interface TaskComponents {
3737
* the extensions provided by this plugin. This is used to parse and
3838
* generate the markdown task for all updates and replacements.
3939
*
40-
* @export
4140
* @class Task
4241
*/
4342
export class Task extends ListItem {

src/TaskSerializer/DefaultTaskSerializer.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ import type { TaskDetails, TaskSerializer } from '.';
1111
/* Interface describing the symbols that {@link DefaultTaskSerializer}
1212
* uses to serialize and deserialize tasks.
1313
*
14-
* @export
1514
* @interface DefaultTaskSerializerSymbols
1615
*/
1716
export interface DefaultTaskSerializerSymbols {

src/TaskSerializer/index.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,6 @@ export type TaskDetails = Writeable<
4242
*
4343
* - Retrieving and setting a fallback scheduled date (done in {@link Task.fromLine})
4444
*
45-
* @exports
4645
* @interface TaskSerializer
4746
*/
4847
export interface TaskSerializer {

0 commit comments

Comments
 (0)