Skip to content

Commit 0629e79

Browse files
docs(Wrapper): update jsdoc.
1 parent 25afa9b commit 0629e79

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

src/lib/wrapper.class.ts

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ export class Wrapper<
4545
}
4646

4747
/**
48-
* The method checks if the value of any type is an instance of the `Wrapper` of any, or given opening and closing chars.
48+
* The method checks if the value of any type is an instance of the `Wrapper` of any, or the given opening, closing chars, and text.
4949
* @param value The value of any type to test against the `Wrapper` instance.
5050
* @param opening Optional opening chars of generic type variable `Opening` to check if the given `value` contains.
5151
* @param closing Optional closing chars of generic type variable `Closing` to check if the given `value` contains.
@@ -70,10 +70,10 @@ export class Wrapper<
7070
}
7171

7272
/**
73-
* Replaces the closing chars in a given text with a given replacement value at the end of the text.
73+
* Replaces the closing chars in a given `text` with a given replacement value at the end of the text.
7474
* @param text The text of `string` type in which given `closing` characters are replaced by a given replacement value.
7575
* @param closing The closing chars of the `string` to replace by a given replacement value at the end of the given `text`.
76-
* @param replaceValue Replacement value for the given closing characters in the given text.
76+
* @param replaceValue Replacement value for the given `closing` characters in the given `text`.
7777
* @returns The return value is the text of `string` type with a replaced closing chars by a given replacement value.
7878
* @angularpackage
7979
*/
@@ -88,10 +88,10 @@ export class Wrapper<
8888
}
8989

9090
/**
91-
* Replaces the opening chars in a given text with a given replacement value at the end of the text.
91+
* Replaces the opening chars in a given `text` with a given replacement value at the end of the text.
9292
* @param text The text of `string` type in which the given `opening` chars are replaced by a given replacement value.
9393
* @param opening The opening chars of the `string` to replace by a given replacement value at the beginning of the given `text`.
94-
* @param replaceValue Replacement value for the opening characters in the given text.
94+
* @param replaceValue Replacement value for the `opening` characters in the given `text`.
9595
* @returns The return value is the text of `string` type with a replaced opening chars by a given replacement value.
9696
* @angularpackage
9797
*/
@@ -110,7 +110,7 @@ export class Wrapper<
110110
* @param text The text of the `string` from which given opening and closing chars are removed.
111111
* @param opening The opening chars of the `string` to be removed in the given `text`.
112112
* @param closing The closing chars of the `string` to be removed in the given `text`.
113-
* @returns The return value is the text without the given opening and closing chars.
113+
* @returns The return value is the text of string type without the given opening and closing chars.
114114
* @angularpackage
115115
*/
116116
public static unwrap(text: string, opening = '', closing = ''): string {
@@ -138,8 +138,8 @@ export class Wrapper<
138138

139139
//#region instance public methods.
140140
/**
141-
* Determines whether the provided `text` has the closing chars of the specified `Wrapper` object.
142-
* @param text The text of `string` to test for the existence of the closing chars at the end in it.
141+
* Determines whether the provided `text` has the closing chars of the specified `Wrapper` object at the end.
142+
* @param text The text of `string` to test for the existence of the closing chars at the end of it.
143143
* @returns The return value is a `boolean` indicating whether the given `text` has the closing of the wrap.
144144
* @angularpackage
145145
*/
@@ -148,7 +148,7 @@ export class Wrapper<
148148
}
149149

150150
/**
151-
* Checks if the provided `text` has the opening of a specified `Wrapper` object at the beginning of the text.
151+
* Checks whether the provided `text` has the opening of a specified `Wrapper` object at the beginning.
152152
* @param text The text of `string` to test for the existence of the opening chars at the beginning of it.
153153
* @returns The return value is a `boolean` indicating whether the given `text` has the opening of the wrap.
154154
* @angularpackage

0 commit comments

Comments
 (0)