docs(Reference): Replace @alias with @see tags

sebbo2002 · Aug 20, 2024 · 53f3d0e · 53f3d0e
1 parent 0b508c4
commit 53f3d0e
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 6 deletions.
diff --git a/src/alarm.ts b/src/alarm.ts
@@ -324,7 +324,8 @@ export default class ICalAlarm {
      * alarm is triggered after the event started.
      *
      * @since 0.2.1
-     * @alias trigger
+     * @see {@link trigger}
+     * @see {@link triggerAfter}
      */
     triggerBefore (trigger: number | ICalDateTimeValue): this;
 
@@ -345,7 +346,8 @@ export default class ICalAlarm {
      * for details about supported values and timezone handling.
      *
      * @since 0.2.1
-     * @alias trigger
+     * @see {@link trigger}
+     * @see {@link triggerAfter}
      */
     triggerBefore (): number | ICalDateTimeValue;
     triggerBefore (trigger?: number | ICalDateTimeValue): this | number | ICalDateTimeValue {

diff --git a/src/event.ts b/src/event.ts
@@ -266,7 +266,7 @@ export default class ICalEvent {
     /**
      * Get the event's ID
      * @since 0.2.0
-     * @alias id
+     * @see {@link id}
      */
     uid(): string;
 
@@ -275,7 +275,6 @@ export default class ICalEvent {
      * If not set, a UUID will be generated randomly.
      *
      * @param id Event ID you want to set
-     * @alias id
      */
     uid(id: string | number): this;
     uid(id?: string | number): this | string {
@@ -487,6 +486,7 @@ export default class ICalEvent {
     /**
      * Get the event's timestamp
      * @since 0.2.0
+     * @see {@link timestamp}
      */
     stamp(): ICalDateTimeValue;
 
@@ -496,6 +496,7 @@ export default class ICalEvent {
      * for details about supported values and timezone handling.
      *
      * @since 0.2.0
+     * @see {@link timestamp}
      */
     stamp(stamp: ICalDateTimeValue): this;
     stamp(stamp?: ICalDateTimeValue): this | ICalDateTimeValue {
@@ -510,7 +511,7 @@ export default class ICalEvent {
     /**
      * Get the event's timestamp
      * @since 0.2.0
-     * @alias stamp
+     * @see {@link stamp}
      */
     timestamp(): ICalDateTimeValue;
 
@@ -520,7 +521,7 @@ export default class ICalEvent {
      * for details about supported values and timezone handling.
      *
      * @since 0.2.0
-     * @alias stamp
+     * @see {@link stamp}
      */
     timestamp(stamp: ICalDateTimeValue): this;
     timestamp(stamp?: ICalDateTimeValue): this | ICalDateTimeValue {