From 079fb65c81672efe210dd7a7b3e920a8bd8e8fd0 Mon Sep 17 00:00:00 2001
From: Georg Schwarz <schwarz@group.riehle.org>
Date: Wed, 31 Jul 2024 17:28:30 +0200
Subject: [PATCH] Replace @see by @link in jsdoc comments

---
 .../src/lib/blocks/execution-result.ts        | 20 +++++++++----------
 .../language-server/src/lib/ast/model-util.ts |  4 ++--
 .../typed-object/block-type-wrapper.ts        |  4 ++--
 .../composite-block-type-wrapper.ts           |  4 ++--
 .../typed-object/constrainttype-wrapper.ts    |  4 ++--
 .../primitive/primitive-value-type.ts         |  2 +-
 .../lib/ast/wrappers/value-type/value-type.ts |  2 +-
 .../RangeConstraint.jv                        |  8 ++++----
 8 files changed, 24 insertions(+), 24 deletions(-)

diff --git a/libs/execution/src/lib/blocks/execution-result.ts b/libs/execution/src/lib/blocks/execution-result.ts
index 265e3a14c..6f26c7c24 100644
--- a/libs/execution/src/lib/blocks/execution-result.ts
+++ b/libs/execution/src/lib/blocks/execution-result.ts
@@ -11,8 +11,8 @@ export interface ExecutionErrorDetails<N extends AstNode = AstNode> {
 }
 
 /**
- * Convenience interfaces and methods wrapping @see Either of fp-ts library.
- * Left is the @see ExecutionErrorDetails
+ * Convenience interfaces and methods wrapping {@link Either} of fp-ts library.
+ * Left is the {@link ExecutionErrorDetails}
  * Right is a generic T
  */
 
@@ -21,37 +21,37 @@ export type Err = E.Left<ExecutionErrorDetails>;
 export type Ok<T> = E.Right<T>;
 
 /**
- * Creates an @see Ok object from a data object typed T.
+ * Creates an {@link Ok} object from a data object typed T.
  * @param data the data object
- * @returns the created @see Ok object
+ * @returns the created {@link Ok} object
  */
 export function ok<T>(data: T): Result<T> {
   return E.right(data);
 }
 /**
- * Creates an @see Err object from a @see ExecutionErrorDetails object.
- * @param details the @see ExecutionErrorDetails object
- * @returns the created @see Err object
+ * Creates an {@link Err} object from a {@link ExecutionErrorDetails} object.
+ * @param details the {@link ExecutionErrorDetails} object
+ * @returns the created {@link Err} object
  */
 export function err<T>(details: ExecutionErrorDetails): Result<T> {
   return E.left(details);
 }
 
 /**
- * Type guard for @see Ok
+ * Type guard for {@link Ok}
  */
 export function isOk<T>(result: Result<T>): result is Ok<T> {
   return E.isRight(result);
 }
 /**
- * Type guard for @see Err
+ * Type guard for {@link Err}
  */
 export function isErr<T>(result: Result<T>): result is Err {
   return E.isLeft(result);
 }
 
 /**
- * Convenience method to get wrapped data of an @see Ok object.
+ * Convenience method to get wrapped data of an {@link Ok} object.
  */
 export function okData<T>(ok: Ok<T>): T {
   return ok.right;
diff --git a/libs/language-server/src/lib/ast/model-util.ts b/libs/language-server/src/lib/ast/model-util.ts
index ea9ccc46c..d243423b9 100644
--- a/libs/language-server/src/lib/ast/model-util.ts
+++ b/libs/language-server/src/lib/ast/model-util.ts
@@ -53,7 +53,7 @@ export function getNextAstNodeContainer<T extends AstNode>(
 /**
  * Utility function that gets all builtin block types.
  * Duplicates are only added once.
- * Make sure to call @see initializeWorkspace first so that the file system is initialized.
+ * Make sure to call {@link initializeWorkspace} first so that the file system is initialized.
  */
 export function getAllBuiltinBlockTypes(
   documentService: LangiumDocuments,
@@ -93,7 +93,7 @@ export function getAllBuiltinBlockTypes(
 /**
  * Utility function that gets all builtin constraint types.
  * Duplicates are only added once.
- * Make sure to call @see initializeWorkspace first so that the file system is initialized.
+ * Make sure to call {@link initializeWorkspace} first so that the file system is initialized.
  */
 export function getAllBuiltinConstraintTypes(
   documentService: LangiumDocuments,
diff --git a/libs/language-server/src/lib/ast/wrappers/typed-object/block-type-wrapper.ts b/libs/language-server/src/lib/ast/wrappers/typed-object/block-type-wrapper.ts
index c13f9a284..132ea2c70 100644
--- a/libs/language-server/src/lib/ast/wrappers/typed-object/block-type-wrapper.ts
+++ b/libs/language-server/src/lib/ast/wrappers/typed-object/block-type-wrapper.ts
@@ -37,9 +37,9 @@ export class BlockTypeWrapper extends TypedObjectWrapper<ReferenceableBlockTypeD
 
   /**
    * Creates a BlockTypeWrapper if possible. Otherwise, throws error.
-   * Use @see canBeWrapped to check whether wrapping will be successful.
+   * Use {@link canBeWrapped} to check whether wrapping will be successful.
    *
-   * Use @see WrapperFactoryProvider for instantiation instead of calling this constructor directly.
+   * Use {@link WrapperFactoryProvider} for instantiation instead of calling this constructor directly.
    */
   constructor(
     toBeWrapped:
diff --git a/libs/language-server/src/lib/ast/wrappers/typed-object/composite-block-type-wrapper.ts b/libs/language-server/src/lib/ast/wrappers/typed-object/composite-block-type-wrapper.ts
index 3667f39c4..0086f0a58 100644
--- a/libs/language-server/src/lib/ast/wrappers/typed-object/composite-block-type-wrapper.ts
+++ b/libs/language-server/src/lib/ast/wrappers/typed-object/composite-block-type-wrapper.ts
@@ -12,9 +12,9 @@ import { BlockTypeWrapper } from './block-type-wrapper';
 export class CompositeBlockTypeWrapper extends BlockTypeWrapper {
   /**
    * Creates a CompositeBlockTypeWrapper if possible. Otherwise, throws error.
-   * Use @see canBeWrapped to check whether wrapping will be successful.
+   * Use {@link canBeWrapped} to check whether wrapping will be successful.
    *
-   * Use @see WrapperFactoryProvider for instantiation instead of calling this constructor directly.
+   * Use {@link WrapperFactoryProvider} for instantiation instead of calling this constructor directly.
    */
   constructor(
     private blockTypeDefinition: CompositeBlockTypeDefinition,
diff --git a/libs/language-server/src/lib/ast/wrappers/typed-object/constrainttype-wrapper.ts b/libs/language-server/src/lib/ast/wrappers/typed-object/constrainttype-wrapper.ts
index b03615828..479cb346d 100644
--- a/libs/language-server/src/lib/ast/wrappers/typed-object/constrainttype-wrapper.ts
+++ b/libs/language-server/src/lib/ast/wrappers/typed-object/constrainttype-wrapper.ts
@@ -32,9 +32,9 @@ export class ConstraintTypeWrapper extends TypedObjectWrapper<BuiltinConstraintt
 
   /**
    * Creates a ConstraintTypeWrapper if possible. Otherwise, throws error.
-   * Use @see canBeWrapped to check whether wrapping will be successful.
+   * Use {@link canBeWrapped} to check whether wrapping will be successful.
    *
-   * Use @see WrapperFactoryProvider for instantiation instead of calling this constructor directly.
+   * Use {@link WrapperFactoryProvider} for instantiation instead of calling this constructor directly.
    */
   constructor(
     toBeWrapped:
diff --git a/libs/language-server/src/lib/ast/wrappers/value-type/primitive/primitive-value-type.ts b/libs/language-server/src/lib/ast/wrappers/value-type/primitive/primitive-value-type.ts
index 2d1f63913..daca2443a 100644
--- a/libs/language-server/src/lib/ast/wrappers/value-type/primitive/primitive-value-type.ts
+++ b/libs/language-server/src/lib/ast/wrappers/value-type/primitive/primitive-value-type.ts
@@ -28,7 +28,7 @@ export abstract class PrimitiveValueType<
   /**
    * The user documentation for the value type.
    * Text only, no comment characters.
-   * Should be given for all user-referenceable value types @see isReferenceableByUser
+   * Should be given for all user-referenceable value types {@link isReferenceableByUser}
    */
   getUserDoc(): string | undefined {
     return undefined;
diff --git a/libs/language-server/src/lib/ast/wrappers/value-type/value-type.ts b/libs/language-server/src/lib/ast/wrappers/value-type/value-type.ts
index 348bae8a8..3095b880d 100644
--- a/libs/language-server/src/lib/ast/wrappers/value-type/value-type.ts
+++ b/libs/language-server/src/lib/ast/wrappers/value-type/value-type.ts
@@ -45,7 +45,7 @@ export interface ValueType<
   /**
    * The convertible relation reflects the ability of primitive types to
    * convert into another primitive value type in a loss-less way (e.g., int to decimal).
-   * Atomic value types inherit (@see isSubtypeOf) the conversion behavior of their primitive value type.
+   * Atomic value types inherit ({@link isSubtypeOf}) the conversion behavior of their primitive value type.
    */
   isConvertibleTo(target: ValueType): boolean;
 
diff --git a/libs/language-server/src/stdlib/builtin-constrainttypes/RangeConstraint.jv b/libs/language-server/src/stdlib/builtin-constrainttypes/RangeConstraint.jv
index 03d4184f4..ed50a7d30 100644
--- a/libs/language-server/src/stdlib/builtin-constrainttypes/RangeConstraint.jv
+++ b/libs/language-server/src/stdlib/builtin-constrainttypes/RangeConstraint.jv
@@ -21,25 +21,25 @@
 publish builtin constrainttype RangeConstraint on decimal {
 	/**
 	* Lower bound for the valid value range.
-	* @see lowerBoundInclusive whether inclusive or exclusive.
+	* See {@link lowerBoundInclusive} whether inclusive or exclusive.
 	* The default value is the smallest usable integer.
 	*/
 	property lowerBound oftype decimal : -9007199254740991;
 
 	/**
-	* Boolean flag whether @see lowerBound is inclusive or exclusive.
+	* Boolean flag whether {@link lowerBound} is inclusive or exclusive.
 	*/
 	property lowerBoundInclusive oftype boolean : true;
 
 	/**
 	* Upper bound for the valid value range.
-	* @see upperBoundInclusive whether inclusive or exclusive.
+	* See {@link upperBoundInclusive} whether inclusive or exclusive.
 	* The default value is the biggest usable integer.
 	*/
 	property upperBound oftype decimal : 9007199254740991;
 
 	/**
-	* Boolean flag whether @see upperBound is inclusive or exclusive.
+	* Boolean flag whether {@link upperBound} is inclusive or exclusive.
 	*/
 	property upperBoundInclusive oftype boolean : true;
 }
\ No newline at end of file