docs: consistent @see jsdoc tags (#2473)

1 files changed, 18 insertions, 0 deletions

diff --git a/test/scripts/apidoc/verify-jsdoc-tags.spec.ts b/test/scripts/apidoc/verify-jsdoc-tags.spec.ts
index 29a487a5..efb1919b 100644
--- a/test/scripts/apidoc/verify-jsdoc-tags.spec.ts
+++ b/test/scripts/apidoc/verify-jsdoc-tags.spec.ts
@@ -274,6 +274,24 @@ describe('verify JSDoc tags', () => {
                 expect(link, 'Expect method reference to contain ()').toContain(
                   ')'
                 );
+                expect(
+                  link,
+                  "Expect method reference to have a ': ' after the parenthesis"
+                ).toContain('): ');
+                expect(
+                  link,
+                  'Expect method reference to have a description starting with a capital letter'
+                ).toMatch(/\): [A-Z]/);
+                expect(
+                  link,
+                  'Expect method reference to start with a standard description phrase'
+                ).toMatch(
+                  /\): (?:For generating |For more information about |For using |For the replacement method)/
+                );
+                expect(
+                  link,
+                  'Expect method reference to have a description ending with a dot'
+                ).toMatch(/\.$/);
                 expect(allowedReferences).toContain(link.replace(/\(.*/, ''));
               }
             }