From 1fe2877d0c6b237b3d1a5b6b29c4749578a8f9a4 Mon Sep 17 00:00:00 2001 From: Matt Mayer Date: Thu, 8 Sep 2022 23:40:52 +0700 Subject: docs: add `@since` tags to all methods (#1337) --- src/modules/git/index.ts | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'src/modules/git') diff --git a/src/modules/git/index.ts b/src/modules/git/index.ts index be8d02f1..da1dfab7 100644 --- a/src/modules/git/index.ts +++ b/src/modules/git/index.ts @@ -19,6 +19,8 @@ export class Git { * * @example * faker.git.branch() // 'feed-parse' + * + * @since 5.0.0 */ branch(): string { const noun = this.faker.hacker.noun().replace(' ', '-'); @@ -42,6 +44,8 @@ export class Git { * // Date: Sat Feb 05 2022 15:09:18 GMT+0100 (Mitteleuropäische Normalzeit) * // * // copy primary system + * + * @since 5.0.0 */ commitEntry( options: { @@ -80,6 +84,8 @@ export class Git { * * @example * faker.git.commitMessage() // 'reboot cross-platform driver' + * + * @since 5.0.0 */ commitMessage(): string { return `${this.faker.hacker.verb()} ${this.faker.hacker.adjective()} ${this.faker.hacker.noun()}`; @@ -90,6 +96,8 @@ export class Git { * * @example * faker.git.commitSha() // '2c6e3880fd94ddb7ef72d34e683cdc0c47bec6e6' + * + * @since 5.0.0 */ commitSha(): string { return this.faker.datatype.hexadecimal({ @@ -104,6 +112,8 @@ export class Git { * * @example * faker.git.shortSha() // '6155732' + * + * @since 5.0.0 */ shortSha(): string { return this.faker.datatype.hexadecimal({ -- cgit v1.2.3