Skip to content

Commit

Permalink
improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
le0pard committed Aug 9, 2023
1 parent 5b5c716 commit 524ef92
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions src/Matcher.js
Original file line number Diff line number Diff line change
Expand Up @@ -325,8 +325,8 @@ class Matcher {
* digits as long as the resulting number is a valid group number for this pattern. To cut it off
* earlier, escape the first digit that should not be used.
*
* @param sb the {@link StringBuilder} to append to
* @param replacement the replacement string
* @param {string} replacement the replacement string
* @param {boolean} perlMode activate perl/js mode (different behaviour for capture groups and special characters)
* @return the {@code Matcher} itself, for chained method calls
* @throws IllegalStateException if there was no most recent match
* @throws IndexOutOfBoundsException if replacement refers to an invalid group
Expand Down Expand Up @@ -546,6 +546,7 @@ class Matcher {
* {@code appendReplacement}.
*
* @param {string} replacement the replacement string
* @param {boolean} perlMode activate perl/js mode (different behaviour for capture groups and special characters)
* @return {string} the input string with the matches replaced
* @throws IndexOutOfBoundsException if replacement refers to an invalid group and perlMode is false
*/
Expand All @@ -558,6 +559,7 @@ class Matcher {
* {@code appendReplacement}.
*
* @param {string} replacement the replacement string
* @param {boolean} perlMode activate perl/js mode (different behaviour for capture groups and special characters)
* @return {string} the input string with the first match replaced
* @throws IndexOutOfBoundsException if replacement refers to an invalid group and perlMode is false
*/
Expand All @@ -569,6 +571,7 @@ class Matcher {
* Helper: replaceAll/replaceFirst hybrid.
* @param {string} replacement
* @param {boolean} all
* @param {boolean} perlMode activate perl/js mode (different behaviour for capture groups and special characters)
* @return {string}
* @private
*/
Expand Down

0 comments on commit 524ef92

Please sign in to comment.