add more jsdocs

ueberdosis · Aug 23, 2023 · 4f5e997 · 4f5e997
1 parent a6c86ba
commit 4f5e997
Show file tree

Hide file tree

Showing 12 changed files with 24 additions and 0 deletions.
diff --git a/packages/core/src/Mark.ts b/packages/core/src/Mark.ts
@@ -525,6 +525,10 @@ declare module '@tiptap/core' {
   }
 }
 
+/**
+ * The Mark class is used to create custom mark extensions.
+ * @see https://tiptap.dev/api/extensions#create-a-new-extension
+ */
 export class Mark<Options = any, Storage = any> {
   type = 'mark'
 

diff --git a/packages/core/src/Node.ts b/packages/core/src/Node.ts
@@ -634,6 +634,10 @@ declare module '@tiptap/core' {
   }
 }
 
+/**
+ * The Node class is used to create custom node extensions.
+ * @see https://tiptap.dev/api/extensions#create-a-new-extension
+ */
 export class Node<Options = any, Storage = any> {
   type = 'node'
 

diff --git a/packages/core/src/NodeView.ts b/packages/core/src/NodeView.ts
@@ -8,6 +8,10 @@ import { DecorationWithType, NodeViewRendererOptions, NodeViewRendererProps } fr
 import { isAndroid } from './utilities/isAndroid.js'
 import { isiOS } from './utilities/isiOS.js'
 
+/**
+ * Node views are used to customize the rendered DOM structure of a node.
+ * @see https://tiptap.dev/guide/node-views
+ */
 export class NodeView<
   Component,
   NodeEditor extends CoreEditor = CoreEditor,

diff --git a/packages/core/src/PasteRule.ts b/packages/core/src/PasteRule.ts
@@ -23,6 +23,10 @@ export type PasteRuleMatch = {
 
 export type PasteRuleFinder = RegExp | ((text: string) => PasteRuleMatch[] | null | undefined)
 
+/**
+ * Paste rules are used to react to pasted content.
+ * @see https://tiptap.dev/guide/custom-extensions/#paste-rules
+ */
 export class PasteRule {
   find: PasteRuleFinder
 

diff --git a/packages/core/src/inputRules/markInputRule.ts b/packages/core/src/inputRules/markInputRule.ts
@@ -8,6 +8,7 @@ import { callOrReturn } from '../utilities/callOrReturn.js'
 /**
  * Build an input rule that adds a mark when the
  * matched text is typed into it.
+ * @see https://tiptap.dev/guide/custom-extensions/#input-rules
  */
 export function markInputRule(config: {
   find: InputRuleFinder

diff --git a/packages/core/src/inputRules/nodeInputRule.ts b/packages/core/src/inputRules/nodeInputRule.ts
@@ -7,6 +7,7 @@ import { callOrReturn } from '../utilities/callOrReturn.js'
 /**
  * Build an input rule that adds a node when the
  * matched text is typed into it.
+ * @see https://tiptap.dev/guide/custom-extensions/#input-rules
  */
 export function nodeInputRule(config: {
   /**

diff --git a/packages/core/src/inputRules/textInputRule.ts b/packages/core/src/inputRules/textInputRule.ts
@@ -3,6 +3,7 @@ import { InputRule, InputRuleFinder } from '../InputRule.js'
 /**
  * Build an input rule that replaces text when the
  * matched text is typed into it.
+ * @see https://tiptap.dev/guide/custom-extensions/#input-rules
  */
 export function textInputRule(config: {
   find: InputRuleFinder,

diff --git a/packages/core/src/inputRules/textblockTypeInputRule.ts b/packages/core/src/inputRules/textblockTypeInputRule.ts
@@ -9,6 +9,7 @@ import { callOrReturn } from '../utilities/callOrReturn.js'
  * matched text is typed into it. When using a regular expresion you’ll
  * probably want the regexp to start with `^`, so that the pattern can
  * only occur at the start of a textblock.
+ * @see https://tiptap.dev/guide/custom-extensions/#input-rules
  */
 export function textblockTypeInputRule(config: {
   find: InputRuleFinder

diff --git a/packages/core/src/inputRules/wrappingInputRule.ts b/packages/core/src/inputRules/wrappingInputRule.ts
@@ -19,6 +19,7 @@ import { callOrReturn } from '../utilities/callOrReturn.js'
  * two nodes. You can pass a join predicate, which takes a regular
  * expression match and the node before the wrapped node, and can
  * return a boolean to indicate whether a join should happen.
+ * @see https://tiptap.dev/guide/custom-extensions/#input-rules
  */
 export function wrappingInputRule(config: {
   find: InputRuleFinder,

diff --git a/packages/core/src/pasteRules/markPasteRule.ts b/packages/core/src/pasteRules/markPasteRule.ts
@@ -8,6 +8,7 @@ import { callOrReturn } from '../utilities/callOrReturn.js'
 /**
  * Build an paste rule that adds a mark when the
  * matched text is pasted into it.
+ * @see https://tiptap.dev/guide/custom-extensions/#paste-rules
  */
 export function markPasteRule(config: {
   find: PasteRuleFinder

diff --git a/packages/core/src/pasteRules/nodePasteRule.ts b/packages/core/src/pasteRules/nodePasteRule.ts
@@ -7,6 +7,7 @@ import { callOrReturn } from '../utilities/index.js'
 /**
  * Build an paste rule that adds a node when the
  * matched text is pasted into it.
+ * @see https://tiptap.dev/guide/custom-extensions/#paste-rules
  */
 export function nodePasteRule(config: {
   find: PasteRuleFinder

diff --git a/packages/core/src/pasteRules/textPasteRule.ts b/packages/core/src/pasteRules/textPasteRule.ts
@@ -3,6 +3,7 @@ import { PasteRule, PasteRuleFinder } from '../PasteRule.js'
 /**
  * Build an paste rule that replaces text when the
  * matched text is pasted into it.
+ * @see https://tiptap.dev/guide/custom-extensions/#paste-rules
  */
 export function textPasteRule(config: {
   find: PasteRuleFinder,