Merge pull request #469 from neo4j/typedoc-improvements

Replace markdown style links to the standard `@link` tsdoc
neo4j · Nov 28, 2024 · 5bf1ea2 · 5bf1ea2
2 parents e612756 + 4ab3f06
commit 5bf1ea2
Show file tree

Hide file tree

Showing 60 changed files with 241 additions and 237 deletions.
diff --git a/DEVELOPING.md b/DEVELOPING.md
@@ -26,7 +26,7 @@ The comments should follow these conventions:
 
 - Brief description
 - @group - This should be the Cypher concept related to this interface. Cypher Functions, Clauses, Operators, Procedures, Other Expressions.
-- @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual) - A link to the element in the Cypher documentation
+- @see {@link https://neo4j.com/docs/cypher-manual | Cypher Documentation} - A link to the element in the Cypher documentation
 - @internal - If used by the library and not exposed
 - @example - example of usage and resulting Cypher
 

diff --git a/src/clauses/Call.ts b/src/clauses/Call.ts
@@ -55,7 +55,7 @@ type InTransactionConfig = {
 };
 
 /**
- * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/call-subquery/)
+ * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/call-subquery/ | Cypher Documentation}
  * @category Clauses
  */
 @mixin(WithReturn, WithWith, WithUnwind, WithDelete, WithSetRemove, WithMatch, WithCreate, WithMerge, WithOrder)
@@ -75,7 +75,7 @@ export class Call extends Clause {
     }
 
     /** Adds a `WITH` statement inside `CALL {`, this `WITH` can is used to import variables outside of the subquery
-     *  @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/subqueries/call-subquery/#call-importing-variables)
+     *  @see {@link https://neo4j.com/docs/cypher-manual/current/subqueries/call-subquery/#call-importing-variables | Cypher Documentation}
      */
     public importWith(...params: Array<Variable | "*">): this {
         if (this._importWith) {
@@ -97,7 +97,7 @@ export class Call extends Clause {
     }
 
     /** Makes the subquery an OPTIONAL CALL
-     * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/subqueries/call-subquery/#optional-call)
+     * @see {@link https://neo4j.com/docs/cypher-manual/current/subqueries/call-subquery/#optional-call | Cypher Documentation}
      * @version Neo4j 5.24
      */
     public optional(): this {
@@ -179,7 +179,7 @@ export class Call extends Clause {
 }
 
 /**
- * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/subqueries/call-subquery/#optional-call)
+ * @see {@link https://neo4j.com/docs/cypher-manual/current/subqueries/call-subquery/#optional-call | Cypher Documentation}
  * @category Clauses
  */
 export class OptionalCall extends Call {

diff --git a/src/clauses/Create.ts b/src/clauses/Create.ts
@@ -34,7 +34,7 @@ import { mixin } from "./utils/mixin";
 export interface Create extends WithReturn, WithSetRemove, WithWith, WithDelete, WithMerge, WithFinish, WithOrder {}
 
 /**
- * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/create/)
+ * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/create/ | Cypher Documentation}
  * @category Clauses
  */
 @mixin(WithReturn, WithSetRemove, WithWith, WithDelete, WithMerge, WithFinish, WithOrder)
@@ -51,7 +51,7 @@ export class Create extends Clause {
     }
 
     /** Add a {@link Create} clause
-     * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/create/)
+     * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/create/ | Cypher Documentation}
      */
     public create(clauseOrPattern: Create | Pattern): Create {
         if (clauseOrPattern instanceof Create) {

diff --git a/src/clauses/Finish.ts b/src/clauses/Finish.ts
@@ -20,7 +20,7 @@
 import { Clause } from "./Clause";
 
 /**
- * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/finish/)
+ * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/finish/ | Cypher Documentation}
  * @category Clauses
  */
 export class Finish extends Clause {

diff --git a/src/clauses/Foreach.ts b/src/clauses/Foreach.ts
@@ -41,7 +41,7 @@ export interface Foreach extends WithWith, WithReturn, WithSetRemove, WithDelete
 type ForeachClauses = Foreach | SetClause | RemoveClause | Create | Merge | DeleteClause;
 
 /**
- * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/foreach/)
+ * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/foreach/ | Cypher Documentation}
  * @category Clauses
  */
 @mixin(WithWith, WithReturn, WithSetRemove, WithDelete, WithCreate, WithMerge)

diff --git a/src/clauses/LoadCSV.ts b/src/clauses/LoadCSV.ts
@@ -31,7 +31,7 @@ import { mixin } from "./utils/mixin";
 export interface LoadCSV extends WithReturn, WithCreate, WithMerge, WithWith, WithWhere, WithCallProcedure {}
 
 /**
- * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/load-csv/)
+ * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/load-csv/ | Cypher Documentation}
  * @category Clauses
  */
 @mixin(WithReturn, WithCreate, WithMerge, WithWith, WithWhere, WithCallProcedure)

diff --git a/src/clauses/Match.ts b/src/clauses/Match.ts
@@ -57,7 +57,7 @@ type ShortestStatement = {
 };
 
 /**
- * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/match/)
+ * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/match/ | Cypher Documentation}
  * @category Clauses
  */
 @mixin(
@@ -85,7 +85,7 @@ export class Match extends Clause {
     }
 
     /** Makes the clause an OPTIONAL MATCH
-     * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/optional-match/)
+     * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/optional-match/ | Cypher Documentation}
      * @example
      * ```ts
      * new Cypher.Match(new Node({labels: ["Movie"]})).optional();
@@ -101,7 +101,7 @@ export class Match extends Clause {
     }
 
     /** Add a {@link Match} clause
-     * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/match/)
+     * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/match/ | Cypher Documentation}
      */
     public match(clauseOrPattern: Match | Pattern): Match {
         if (clauseOrPattern instanceof Match) {
@@ -116,7 +116,7 @@ export class Match extends Clause {
     }
 
     /** Add an {@link OptionalMatch} clause
-     * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/optional-match/)
+     * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/optional-match/ | Cypher Documentation}
      */
     public optionalMatch(pattern: Pattern): OptionalMatch {
         const matchClause = new OptionalMatch(pattern);
@@ -186,7 +186,7 @@ export class Match extends Clause {
 }
 
 /**
- * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/optional-match/)
+ * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/optional-match/ | Cypher Documentation}
  * @category Clauses
  */
 export class OptionalMatch extends Match {

diff --git a/src/clauses/Merge.ts b/src/clauses/Merge.ts
@@ -37,7 +37,7 @@ import { mixin } from "./utils/mixin";
 export interface Merge extends WithReturn, WithSetRemove, WithDelete, WithWith, WithCreate, WithFinish, WithOrder {}
 
 /**
- * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/merge/)
+ * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/merge/ | Cypher Documentation}
  * @category Clauses
  */
 @mixin(WithReturn, WithSetRemove, WithDelete, WithWith, WithCreate, WithFinish, WithOrder)
@@ -65,7 +65,7 @@ export class Merge extends Clause {
     }
 
     /** Add a {@link Merge} clause
-     * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/merge/)
+     * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/merge/ | Cypher Documentation}
      */
     public merge(clauseOrPattern: Merge | Pattern): Merge {
         if (clauseOrPattern instanceof Merge) {

diff --git a/src/clauses/Return.ts b/src/clauses/Return.ts
@@ -29,7 +29,7 @@ import { mixin } from "./utils/mixin";
 export interface Return extends WithOrder {}
 
 /**
- * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/return/)
+ * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/return/ | Cypher Documentation}
  * @category Clauses
  */
 @mixin(WithOrder)

diff --git a/src/clauses/Union.ts b/src/clauses/Union.ts
@@ -22,7 +22,7 @@ import type { CypherEnvironment } from "../Environment";
 import { Clause } from "./Clause";
 
 /**
- * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/union/)
+ * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/union/ | Cypher Documentation}
  * @category Clauses
  */
 export class Union extends Clause {

diff --git a/src/clauses/Unwind.ts b/src/clauses/Unwind.ts
@@ -46,7 +46,7 @@ export interface Unwind
 export type UnwindProjectionColumn = [Expr, string | Variable | Literal];
 
 /**
- * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/unwind/)
+ * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/unwind/ | Cypher Documentation}
  * @category Clauses
  */
 @mixin(WithWith, WithDelete, WithMatch, WithReturn, WithSetRemove, WithCreate, WithMerge, WithOrder)
@@ -60,7 +60,7 @@ export class Unwind extends Clause {
 
     // Cannot be part of WithUnwind due to dependency cycles
     /** Append an {@link Unwind} clause.
-     * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/unwind/)
+     * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/unwind/ | Cypher Documentation}
      */
     public unwind(clause: Unwind): Unwind;
     public unwind(projection: UnwindProjectionColumn): Unwind;

diff --git a/src/clauses/Use.ts b/src/clauses/Use.ts
@@ -22,7 +22,7 @@ import type { CypherEnvironment } from "../Environment";
 import { Clause } from "./Clause";
 
 /**
- * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/5/clauses/use/)
+ * @see {@link https://neo4j.com/docs/cypher-manual/5/clauses/use/ | Cypher Documentation}
  * @category Clauses
  */
 export class Use extends Clause {

diff --git a/src/clauses/With.ts b/src/clauses/With.ts
@@ -52,7 +52,7 @@ export interface With
         WithCall {}
 
 /**
- * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/with/)
+ * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/with/ | Cypher Documentation}
  * @category Clauses
  */
 @mixin(
@@ -89,7 +89,7 @@ export class With extends Clause {
 
     // Cannot be part of WithWith due to dependency cycles
     /** Add a {@link With} clause
-     * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/with/)
+     * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/with/ | Cypher Documentation}
      */
     public with(clause: With): With;
     public with(...columns: Array<"*" | WithProjection>): With;

diff --git a/src/clauses/mixins/clauses/WithCall.ts b/src/clauses/mixins/clauses/WithCall.ts
@@ -23,7 +23,7 @@ import { MixinClause } from "../Mixin";
 
 export abstract class WithCall extends MixinClause {
     /** Add a {@link Call} clause
-     * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/subqueries/call-subquery/)
+     * @see {@link https://neo4j.com/docs/cypher-manual/current/subqueries/call-subquery/ | Cypher Documentation}
      */
     public call(subquery: Clause, variableScope?: Variable[] | "*"): Call {
         const callClause = new Call(subquery, variableScope);

diff --git a/src/clauses/mixins/clauses/WithCallProcedure.ts b/src/clauses/mixins/clauses/WithCallProcedure.ts
@@ -22,7 +22,7 @@ import { MixinClause } from "../Mixin";
 
 export abstract class WithCallProcedure extends MixinClause {
     /** Add a call {@link Procedure} clause
-     * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/call/)
+     * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/call/ | Cypher Documentation}
      */
     public callProcedure<T extends CypherProcedure | VoidCypherProcedure>(procedure: T): T {
         this.addNextClause(procedure);

diff --git a/src/clauses/mixins/clauses/WithCreate.ts b/src/clauses/mixins/clauses/WithCreate.ts
@@ -23,7 +23,7 @@ import { MixinClause } from "../Mixin";
 
 export abstract class WithCreate extends MixinClause {
     /** Add a {@link Create} clause
-     * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/create/)
+     * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/create/ | Cypher Documentation}
      */
 
     public create(clauseOrPattern: Create | Pattern): Create {

diff --git a/src/clauses/mixins/clauses/WithFinish.ts b/src/clauses/mixins/clauses/WithFinish.ts
@@ -22,7 +22,7 @@ import { MixinClause } from "../Mixin";
 
 export abstract class WithFinish extends MixinClause {
     /** Append a {@link Finish} clause
-     * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/finish/)
+     * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/finish/ | Cypher Documentation}
      */
     public finish(): Finish {
         const finishClause = new Finish();

diff --git a/src/clauses/mixins/clauses/WithMatch.ts b/src/clauses/mixins/clauses/WithMatch.ts
@@ -23,7 +23,7 @@ import { MixinClause } from "../Mixin";
 
 export abstract class WithMatch extends MixinClause {
     /** Add a {@link Match} clause
-     * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/match/)
+     * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/match/ | Cypher Documentation}
      */
 
     public match(clauseOrPattern: Match | Pattern): Match {
@@ -39,7 +39,7 @@ export abstract class WithMatch extends MixinClause {
     }
 
     /** Add an {@link OptionalMatch} clause
-     * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/optional-match/)
+     * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/optional-match/ | Cypher Documentation}
      */
 
     public optionalMatch(pattern: Pattern): OptionalMatch {

diff --git a/src/clauses/mixins/clauses/WithMerge.ts b/src/clauses/mixins/clauses/WithMerge.ts
@@ -23,7 +23,7 @@ import { MixinClause } from "../Mixin";
 
 export abstract class WithMerge extends MixinClause {
     /** Add a {@link Merge} clause
-     * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/merge/)
+     * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/merge/ | Cypher Documentation}
      */
 
     public merge(clauseOrPattern: Merge | Pattern): Merge {

diff --git a/src/clauses/mixins/clauses/WithReturn.ts b/src/clauses/mixins/clauses/WithReturn.ts
@@ -23,7 +23,7 @@ import { MixinClause } from "../Mixin";
 
 export abstract class WithReturn extends MixinClause {
     /** Append a {@link Return} clause
-     * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/return/)
+     * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/return/ | Cypher Documentation}
      */
     public return(clause: Return): Return;
     public return(...columns: Array<"*" | ProjectionColumn>): Return;

diff --git a/src/clauses/mixins/clauses/WithUnwind.ts b/src/clauses/mixins/clauses/WithUnwind.ts
@@ -23,7 +23,7 @@ import { MixinClause } from "../Mixin";
 
 export abstract class WithUnwind extends MixinClause {
     /** Append an {@link Unwind} clause.
-     * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/unwind/)
+     * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/unwind/ | Cypher Documentation}
      */
     public unwind(clause: Unwind): Unwind;
     public unwind(projection: UnwindProjectionColumn): Unwind;

diff --git a/src/clauses/mixins/clauses/WithWith.ts b/src/clauses/mixins/clauses/WithWith.ts
@@ -23,7 +23,7 @@ import { MixinClause } from "../Mixin";
 
 export abstract class WithWith extends MixinClause {
     /** Add a {@link With} clause
-     * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/with/)
+     * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/with/ | Cypher Documentation}
      */
     public with(clause: With): With;
     public with(...columns: Array<"*" | WithProjection>): With;

diff --git a/src/clauses/mixins/sub-clauses/WithDelete.ts b/src/clauses/mixins/sub-clauses/WithDelete.ts
@@ -25,15 +25,15 @@ export abstract class WithDelete extends Mixin {
     protected deleteClause: DeleteClause | undefined;
 
     /** Add a `DELETE` subclause
-     * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/delete/)
+     * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/delete/ | Cypher Documentation}
      */
     public delete(...deleteInput: DeleteInput): this {
         this.createDeleteClause(deleteInput);
         return this;
     }
 
     /** Adds a `DETACH DELETE` subclause
-     * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/delete/)
+     * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/delete/ | Cypher Documentation}
      */
     public detachDelete(...deleteInput: DeleteInput): this {
         const deleteClause = this.createDeleteClause(deleteInput);
@@ -42,7 +42,7 @@ export abstract class WithDelete extends Mixin {
     }
 
     /** Add a `NODETACH DELETE` subclause
-     * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/delete/#delete-nodetach)
+     * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/delete/#delete-nodetach | Cypher Documentation}
      * @version Neo4j 5.14
      */
     public noDetachDelete(...deleteInput: DeleteInput): this {

diff --git a/src/clauses/mixins/sub-clauses/WithOrder.ts b/src/clauses/mixins/sub-clauses/WithOrder.ts
@@ -28,7 +28,7 @@ export abstract class WithOrder extends Mixin {
     protected orderByStatement: OrderBy | undefined;
 
     /** Add an `ORDER BY` subclause. Note that `ASC` is the default sorting order
-     * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/order-by/)
+     * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/order-by/ | Cypher Documentation}
      */
     public orderBy(...exprs: Array<[Expr, Order] | Expr | [Expr]>): this {
         const normalizedExprs = exprs.map((rawExpr): [Expr, Order] => {
@@ -45,7 +45,7 @@ export abstract class WithOrder extends Mixin {
     }
 
     /** Add a `SKIP` subclause.
-     * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/skip/)
+     * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/skip/ | Cypher Documentation}
      */
     public skip(value: number | Expr): this {
         const orderByStatement = this.getOrCreateOrderBy();
@@ -54,7 +54,7 @@ export abstract class WithOrder extends Mixin {
     }
 
     /** Add a `OFFSET` subclause. An alias to `SKIP`
-     * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/skip/#offset-synonym)
+     * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/skip/#offset-synonym | Cypher Documentation}
      * @version Neo4j 5.24
      */
     public offset(value: number | Expr): this {
@@ -64,7 +64,7 @@ export abstract class WithOrder extends Mixin {
     }
 
     /** Add a `LIMIT` subclause.
-     * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/limit/)
+     * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/limit/ | Cypher Documentation}
      */
     public limit(value: number | Expr): this {
         const orderByStatement = this.getOrCreateOrderBy();

diff --git a/src/clauses/mixins/sub-clauses/WithSetRemove.ts b/src/clauses/mixins/sub-clauses/WithSetRemove.ts
@@ -30,7 +30,7 @@ export abstract class WithSetRemove extends Mixin {
     private subClauses: Array<SetClause | RemoveClause> | undefined;
 
     /** Append a `SET` clause. Allowing to assign variable properties to values.
-     * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/set/)
+     * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/set/ | Cypher Documentation}
      */
     public set(...params: SetParam[]): this {
         if (!this.subClauses) {
@@ -47,7 +47,7 @@ export abstract class WithSetRemove extends Mixin {
     }
 
     /** Append a `REMOVE` clause.
-     * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/remove/)
+     * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/remove/ | Cypher Documentation}
      */
     public remove(...properties: Array<PropertyRef | Label>): this {
         if (!this.subClauses) {

diff --git a/src/clauses/mixins/sub-clauses/WithWhere.ts b/src/clauses/mixins/sub-clauses/WithWhere.ts
@@ -34,7 +34,7 @@ export abstract class WithWhere extends Mixin {
     protected whereSubClause: Where | undefined;
 
     /** Add a `WHERE` subclause
-     * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/where/)
+     * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/where/ | Cypher Documentation}
      */
     public where(input: Predicate | undefined): this;
     public where(target: Variable | PropertyRef, params: Record<string, VariableLike>): this;