aboutsummaryrefslogtreecommitdiff
path: root/test/scripts/apidocs/method.example.ts
diff options
context:
space:
mode:
authorShinigami <[email protected]>2025-06-17 21:30:05 +0200
committerGitHub <[email protected]>2025-06-17 21:30:05 +0200
commit04e8b7bab82069bf60961580e353e36096bc2120 (patch)
treec2889fd024c7d30e9af1211f2ae7736e28215e8a /test/scripts/apidocs/method.example.ts
parent1726ded4e61e9f7ce7b76a1759da820270a7a316 (diff)
downloadfaker-04e8b7bab82069bf60961580e353e36096bc2120.tar.xz
faker-04e8b7bab82069bf60961580e353e36096bc2120.zip
docs: add remarks about external sources (#3452)
Diffstat (limited to 'test/scripts/apidocs/method.example.ts')
-rw-r--r--test/scripts/apidocs/method.example.ts24
1 files changed, 24 insertions, 0 deletions
diff --git a/test/scripts/apidocs/method.example.ts b/test/scripts/apidocs/method.example.ts
index 73632b42..0012f4fa 100644
--- a/test/scripts/apidocs/method.example.ts
+++ b/test/scripts/apidocs/method.example.ts
@@ -448,6 +448,30 @@ export class SignatureTest {
}
/**
+ * Test with remark marker.
+ *
+ * @remark This text is special.
+ *
+ * @since 1.0.0
+ */
+ methodWithRemark(): number {
+ return 0;
+ }
+
+ /**
+ * Test with multiple remark markers.
+ *
+ * @remark First special text.
+ * @remark Second special text.
+ * @remark Thrid special text.
+ *
+ * @since 1.0.0
+ */
+ methodWithMultipleRemarks(): number {
+ return 0;
+ }
+
+ /**
* Complex array parameter.
*
* @template T The type of the entries to pick from.