ICU-66108.tar.gz

[apple/icu.git] / icuSources / i18n / unicode / regex.h

diff --git a/icuSources/i18n/unicode/regex.h b/icuSources/i18n/unicode/regex.h
index 8e3b1cb30f7cc4f8ef4dfd2ad1b9188773c2e918..6338eb7c754eff8a097bd864a08088dd28d215b2 100644 (file)
--- a/icuSources/i18n/unicode/regex.h
+++ b/icuSources/i18n/unicode/regex.h
@@ -24,28 +24,28 @@
  * \file
  * \brief  C++ API:  Regular Expressions
  *
  * \file
  * \brief  C++ API:  Regular Expressions
  *

- * <h2>Regular Expression API</h2>
- *
- * <p>The ICU API for processing regular expressions consists of two classes,
- *  <code>RegexPattern</code> and <code>RegexMatcher</code>.
- *  <code>RegexPattern</code> objects represent a pre-processed, or compiled
+ * The ICU API for processing regular expressions consists of two classes,
+ *  `RegexPattern` and `RegexMatcher`.
+ *  `RegexPattern` objects represent a pre-processed, or compiled

  *  regular expression.  They are created from a regular expression pattern string,
  *  regular expression.  They are created from a regular expression pattern string,

- *  and can be used to create <code>RegexMatcher</code> objects for the pattern.</p>
+ *  and can be used to create `RegexMatcher` objects for the pattern.

  *
  *

- * <p>Class <code>RegexMatcher</code> bundles together a regular expression
+ * Class `RegexMatcher` bundles together a regular expression

  *  pattern and a target string to which the search pattern will be applied.
  *  pattern and a target string to which the search pattern will be applied.

- *  <code>RegexMatcher</code> includes API for doing plain find or search
+ *  `RegexMatcher` includes API for doing plain find or search

  *  operations, for search and replace operations, and for obtaining detailed
  *  operations, for search and replace operations, and for obtaining detailed

- *  information about bounds of a match. </p>
+ *  information about bounds of a match.

  *
  *

- * <p>Note that by constructing <code>RegexMatcher</code> objects directly from regular
+ * Note that by constructing `RegexMatcher` objects directly from regular

  * expression pattern strings application code can be simplified and the explicit
  * expression pattern strings application code can be simplified and the explicit

- * need for <code>RegexPattern</code> objects can usually be eliminated.
- * </p>
+ * need for `RegexPattern` objects can usually be eliminated.
+ *

  */
 
 #include "unicode/utypes.h"
 
  */
 
 #include "unicode/utypes.h"
 

+#if U_SHOW_CPLUSPLUS_API
+

 #if !UCONFIG_NO_REGULAR_EXPRESSIONS
 
 #include "unicode/uobject.h"
 #if !UCONFIG_NO_REGULAR_EXPRESSIONS
 
 #include "unicode/uobject.h"


@@ -59,7 +59,6 @@
 
 struct UHashtable;
 
 
 struct UHashtable;
 

-#if U_SHOW_CPLUSPLUS_API

 U_NAMESPACE_BEGIN
 
 struct Regex8BitSet;
 U_NAMESPACE_BEGIN
 
 struct Regex8BitSet;


@@ -75,13 +74,13 @@ class  UVector64;
 
 
 /**
 
 
 /**

-  * Class <code>RegexPattern</code> represents a compiled regular expression.  It includes
+  * Class `RegexPattern` represents a compiled regular expression.  It includes

   * factory methods for creating a RegexPattern object from the source (string) form
   * of a regular expression, methods for creating RegexMatchers that allow the pattern
   * to be applied to input text, and a few convenience methods for simple common
   * uses of regular expressions.
   *
   * factory methods for creating a RegexPattern object from the source (string) form
   * of a regular expression, methods for creating RegexMatchers that allow the pattern
   * to be applied to input text, and a few convenience methods for simple common
   * uses of regular expressions.
   *

-  * <p>Class RegexPattern is not intended to be subclassed.</p>
+  * Class RegexPattern is not intended to be subclassed.

   *
   * @stable ICU 2.4
   */
   *
   * @stable ICU 2.4
   */


@@ -91,7 +90,7 @@ public:
     /**
      * default constructor.  Create a RegexPattern object that refers to no actual
      *   pattern.  Not normally needed; RegexPattern objects are usually
     /**
      * default constructor.  Create a RegexPattern object that refers to no actual
      *   pattern.  Not normally needed; RegexPattern objects are usually

-     *   created using the factory method <code>compile()</code>.
+     *   created using the factory method `compile()`.

      *
      * @stable ICU 2.4
      */
      *
      * @stable ICU 2.4
      */


@@ -114,7 +113,7 @@ public:
 
     /**
      * Comparison operator.  Two RegexPattern objects are considered equal if they
 
     /**
      * Comparison operator.  Two RegexPattern objects are considered equal if they

-     * were constructed from identical source patterns using the same match flag
+     * were constructed from identical source patterns using the same #URegexpFlag

      * settings.
      * @param that a RegexPattern object to compare with "this".
      * @return TRUE if the objects are equivalent.
      * settings.
      * @param that a RegexPattern object to compare with "this".
      * @return TRUE if the objects are equivalent.


@@ -124,7 +123,7 @@ public:
 
     /**
      * Comparison operator.  Two RegexPattern objects are considered equal if they
 
     /**
      * Comparison operator.  Two RegexPattern objects are considered equal if they

-     * were constructed from identical source patterns using the same match flag
+     * were constructed from identical source patterns using the same #URegexpFlag

      * settings.
      * @param that a RegexPattern object to compare with "this".
      * @return TRUE if the objects are different.
      * settings.
      * @param that a RegexPattern object to compare with "this".
      * @return TRUE if the objects are different.


@@ -154,16 +153,16 @@ public:
     * object.  These compile methods, rather than the constructors, are the usual
     * way that RegexPattern objects are created.
     *
     * object.  These compile methods, rather than the constructors, are the usual
     * way that RegexPattern objects are created.
     *

-    * <p>Note that RegexPattern objects must not be deleted while RegexMatcher
+    * Note that RegexPattern objects must not be deleted while RegexMatcher

     * objects created from the pattern are active.  RegexMatchers keep a pointer
     * back to their pattern, so premature deletion of the pattern is a
     * objects created from the pattern are active.  RegexMatchers keep a pointer
     * back to their pattern, so premature deletion of the pattern is a

-    * catastrophic error.</p>
+    * catastrophic error.

     *
     *

-    * <p>All pattern match mode flags are set to their default values.</p>
+    * All #URegexpFlag pattern match mode flags are set to their default values.

     *
     *

-    * <p>Note that it is often more convenient to construct a RegexMatcher directly
+    * Note that it is often more convenient to construct a RegexMatcher directly

     *    from a pattern string rather than separately compiling the pattern and
     *    from a pattern string rather than separately compiling the pattern and

-    *    then creating a RegexMatcher object from the pattern.</p>
+    *    then creating a RegexMatcher object from the pattern.

     *
     * @param regex The regular expression to be compiled.
     * @param pe    Receives the position (line and column nubers) of any error
     *
     * @param regex The regular expression to be compiled.
     * @param pe    Receives the position (line and column nubers) of any error


@@ -182,16 +181,16 @@ public:
     * object.  These compile methods, rather than the constructors, are the usual
     * way that RegexPattern objects are created.
     *
     * object.  These compile methods, rather than the constructors, are the usual
     * way that RegexPattern objects are created.
     *

-    * <p>Note that RegexPattern objects must not be deleted while RegexMatcher
+    * Note that RegexPattern objects must not be deleted while RegexMatcher

     * objects created from the pattern are active.  RegexMatchers keep a pointer
     * back to their pattern, so premature deletion of the pattern is a
     * objects created from the pattern are active.  RegexMatchers keep a pointer
     * back to their pattern, so premature deletion of the pattern is a

-    * catastrophic error.</p>
+    * catastrophic error.

     *
     *

-    * <p>All pattern match mode flags are set to their default values.</p>
+    * All #URegexpFlag pattern match mode flags are set to their default values.

     *
     *

-    * <p>Note that it is often more convenient to construct a RegexMatcher directly
+    * Note that it is often more convenient to construct a RegexMatcher directly

     *    from a pattern string rather than separately compiling the pattern and
     *    from a pattern string rather than separately compiling the pattern and

-    *    then creating a RegexMatcher object from the pattern.</p>
+    *    then creating a RegexMatcher object from the pattern.

     *
     * @param regex The regular expression to be compiled. Note, the text referred
     *              to by this UText must not be deleted during the lifetime of the
     *
     * @param regex The regular expression to be compiled. Note, the text referred
     *              to by this UText must not be deleted during the lifetime of the


@@ -209,21 +208,21 @@ public:
 
    /**
     * Compiles the regular expression in string form into a RegexPattern
 
    /**
     * Compiles the regular expression in string form into a RegexPattern

-    * object using the specified match mode flags.  These compile methods,
+    * object using the specified #URegexpFlag match mode flags.  These compile methods,

     * rather than the constructors, are the usual way that RegexPattern objects
     * are created.
     *
     * rather than the constructors, are the usual way that RegexPattern objects
     * are created.
     *

-    * <p>Note that RegexPattern objects must not be deleted while RegexMatcher
+    * Note that RegexPattern objects must not be deleted while RegexMatcher

     * objects created from the pattern are active.  RegexMatchers keep a pointer
     * back to their pattern, so premature deletion of the pattern is a
     * objects created from the pattern are active.  RegexMatchers keep a pointer
     * back to their pattern, so premature deletion of the pattern is a

-    * catastrophic error.</p>
+    * catastrophic error.

     *
     *

-    * <p>Note that it is often more convenient to construct a RegexMatcher directly
+    * Note that it is often more convenient to construct a RegexMatcher directly

     *    from a pattern string instead of than separately compiling the pattern and
     *    from a pattern string instead of than separately compiling the pattern and

-    *    then creating a RegexMatcher object from the pattern.</p>
+    *    then creating a RegexMatcher object from the pattern.

     *
     * @param regex The regular expression to be compiled.
     *
     * @param regex The regular expression to be compiled.

-    * @param flags The match mode flags to be used.
+    * @param flags The #URegexpFlag match mode flags to be used, e.g. #UREGEX_CASE_INSENSITIVE.

     * @param pe    Receives the position (line and column numbers) of any error
     *              within the regular expression.)
     * @param status   A reference to a UErrorCode to receive any errors.
     * @param pe    Receives the position (line and column numbers) of any error
     *              within the regular expression.)
     * @param status   A reference to a UErrorCode to receive any errors.


@@ -238,23 +237,23 @@ public:
 
    /**
     * Compiles the regular expression in string form into a RegexPattern
 
    /**
     * Compiles the regular expression in string form into a RegexPattern

-    * object using the specified match mode flags.  These compile methods,
+    * object using the specified #URegexpFlag match mode flags.  These compile methods,

     * rather than the constructors, are the usual way that RegexPattern objects
     * are created.
     *
     * rather than the constructors, are the usual way that RegexPattern objects
     * are created.
     *

-    * <p>Note that RegexPattern objects must not be deleted while RegexMatcher
+    * Note that RegexPattern objects must not be deleted while RegexMatcher

     * objects created from the pattern are active.  RegexMatchers keep a pointer
     * back to their pattern, so premature deletion of the pattern is a
     * objects created from the pattern are active.  RegexMatchers keep a pointer
     * back to their pattern, so premature deletion of the pattern is a

-    * catastrophic error.</p>
+    * catastrophic error.

     *
     *

-    * <p>Note that it is often more convenient to construct a RegexMatcher directly
+    * Note that it is often more convenient to construct a RegexMatcher directly

     *    from a pattern string instead of than separately compiling the pattern and
     *    from a pattern string instead of than separately compiling the pattern and

-    *    then creating a RegexMatcher object from the pattern.</p>
+    *    then creating a RegexMatcher object from the pattern.

     *
     * @param regex The regular expression to be compiled. Note, the text referred
     *              to by this UText must not be deleted during the lifetime of the
     *              RegexPattern object or any RegexMatcher object created from it.
     *
     * @param regex The regular expression to be compiled. Note, the text referred
     *              to by this UText must not be deleted during the lifetime of the
     *              RegexPattern object or any RegexMatcher object created from it.

-    * @param flags The match mode flags to be used.
+    * @param flags The #URegexpFlag match mode flags to be used, e.g. #UREGEX_CASE_INSENSITIVE.

     * @param pe    Receives the position (line and column numbers) of any error
     *              within the regular expression.)
     * @param status   A reference to a UErrorCode to receive any errors.
     * @param pe    Receives the position (line and column numbers) of any error
     *              within the regular expression.)
     * @param status   A reference to a UErrorCode to receive any errors.


@@ -269,21 +268,21 @@ public:
 
    /**
     * Compiles the regular expression in string form into a RegexPattern
 
    /**
     * Compiles the regular expression in string form into a RegexPattern

-    * object using the specified match mode flags.  These compile methods,
+    * object using the specified #URegexpFlag match mode flags.  These compile methods,

     * rather than the constructors, are the usual way that RegexPattern objects
     * are created.
     *
     * rather than the constructors, are the usual way that RegexPattern objects
     * are created.
     *

-    * <p>Note that RegexPattern objects must not be deleted while RegexMatcher
+    * Note that RegexPattern objects must not be deleted while RegexMatcher

     * objects created from the pattern are active.  RegexMatchers keep a pointer
     * back to their pattern, so premature deletion of the pattern is a
     * objects created from the pattern are active.  RegexMatchers keep a pointer
     * back to their pattern, so premature deletion of the pattern is a

-    * catastrophic error.</p>
+    * catastrophic error.

     *
     *

-    * <p>Note that it is often more convenient to construct a RegexMatcher directly
+    * Note that it is often more convenient to construct a RegexMatcher directly

     *    from a pattern string instead of than separately compiling the pattern and
     *    from a pattern string instead of than separately compiling the pattern and

-    *    then creating a RegexMatcher object from the pattern.</p>
+    *    then creating a RegexMatcher object from the pattern.

     *
     * @param regex The regular expression to be compiled.
     *
     * @param regex The regular expression to be compiled.

-    * @param flags The match mode flags to be used.
+    * @param flags The #URegexpFlag match mode flags to be used, e.g. #UREGEX_CASE_INSENSITIVE.

     * @param status   A reference to a UErrorCode to receive any errors.
     * @return      A regexPattern object for the compiled pattern.
     *
     * @param status   A reference to a UErrorCode to receive any errors.
     * @return      A regexPattern object for the compiled pattern.
     *


@@ -295,23 +294,23 @@ public:
 
    /**
     * Compiles the regular expression in string form into a RegexPattern
 
    /**
     * Compiles the regular expression in string form into a RegexPattern

-    * object using the specified match mode flags.  These compile methods,
+    * object using the specified #URegexpFlag match mode flags.  These compile methods,

     * rather than the constructors, are the usual way that RegexPattern objects
     * are created.
     *
     * rather than the constructors, are the usual way that RegexPattern objects
     * are created.
     *

-    * <p>Note that RegexPattern objects must not be deleted while RegexMatcher
+    * Note that RegexPattern objects must not be deleted while RegexMatcher

     * objects created from the pattern are active.  RegexMatchers keep a pointer
     * back to their pattern, so premature deletion of the pattern is a
     * objects created from the pattern are active.  RegexMatchers keep a pointer
     * back to their pattern, so premature deletion of the pattern is a

-    * catastrophic error.</p>
+    * catastrophic error.

     *
     *

-    * <p>Note that it is often more convenient to construct a RegexMatcher directly
+    * Note that it is often more convenient to construct a RegexMatcher directly

     *    from a pattern string instead of than separately compiling the pattern and
     *    from a pattern string instead of than separately compiling the pattern and

-    *    then creating a RegexMatcher object from the pattern.</p>
+    *    then creating a RegexMatcher object from the pattern.

     *
     * @param regex The regular expression to be compiled. Note, the text referred
     *              to by this UText must not be deleted during the lifetime of the
     *              RegexPattern object or any RegexMatcher object created from it.
     *
     * @param regex The regular expression to be compiled. Note, the text referred
     *              to by this UText must not be deleted during the lifetime of the
     *              RegexPattern object or any RegexMatcher object created from it.

-    * @param flags The match mode flags to be used.
+    * @param flags The #URegexpFlag match mode flags to be used, e.g. #UREGEX_CASE_INSENSITIVE.

     * @param status   A reference to a UErrorCode to receive any errors.
     * @return      A regexPattern object for the compiled pattern.
     *
     * @param status   A reference to a UErrorCode to receive any errors.
     * @return      A regexPattern object for the compiled pattern.
     *


@@ -322,8 +321,8 @@ public:
         UErrorCode           &status);
 
    /**
         UErrorCode           &status);
 
    /**

-    * Get the match mode flags that were used when compiling this pattern.
-    * @return  the match mode flags
+    * Get the #URegexpFlag match mode flags that were used when compiling this pattern.
+    * @return  the #URegexpFlag match mode flags

     * @stable ICU 2.4
     */
     virtual uint32_t flags() const;
     * @stable ICU 2.4
     */
     virtual uint32_t flags() const;


@@ -333,7 +332,7 @@ public:
     * RegexMatcher can then be used to perform match, find or replace operations
     * on the input.  Note that a RegexPattern object must not be deleted while
     * RegexMatchers created from it still exist and might possibly be used again.
     * RegexMatcher can then be used to perform match, find or replace operations
     * on the input.  Note that a RegexPattern object must not be deleted while
     * RegexMatchers created from it still exist and might possibly be used again.

-    * <p>
+    *

     * The matcher will retain a reference to the supplied input string, and all regexp
     * pattern matching operations happen directly on this original string.  It is
     * critical that the string not be altered or deleted before use by the regular
     * The matcher will retain a reference to the supplied input string, and all regexp
     * pattern matching operations happen directly on this original string.  It is
     * critical that the string not be altered or deleted before use by the regular


@@ -353,12 +352,12 @@ private:
      * Cause a compilation error if an application accidentally attempts to
      *   create a matcher with a (char16_t *) string as input rather than
      *   a UnicodeString.  Avoids a dangling reference to a temporary string.
      * Cause a compilation error if an application accidentally attempts to
      *   create a matcher with a (char16_t *) string as input rather than
      *   a UnicodeString.  Avoids a dangling reference to a temporary string.

-     * <p>
+     *

      * To efficiently work with char16_t *strings, wrap the data in a UnicodeString
      * using one of the aliasing constructors, such as
      * To efficiently work with char16_t *strings, wrap the data in a UnicodeString
      * using one of the aliasing constructors, such as

-     * <code>UnicodeString(UBool isTerminated, const char16_t *text, int32_t textLength);</code>
+     * `UnicodeString(UBool isTerminated, const char16_t *text, int32_t textLength);`

      * or in a UText, using
      * or in a UText, using

-     * <code>utext_openUChars(UText *ut, const char16_t *text, int64_t textLength, UErrorCode *status);</code>
+     * `utext_openUChars(UText *ut, const char16_t *text, int64_t textLength, UErrorCode *status);`

      *
      */
     RegexMatcher *matcher(const char16_t *input,
      *
      */
     RegexMatcher *matcher(const char16_t *input,


@@ -522,7 +521,7 @@ public:
 
 
     /**
 
 
     /**

-     * Split a string into fields.  Somewhat like split() from Perl or Java.
+     * Split a string into fields.  Somewhat like %split() from Perl or Java.

      * Pattern matches identify delimiters that separate the input
      * into fields.  The input data between the delimiters becomes the
      * fields themselves.
      * Pattern matches identify delimiters that separate the input
      * into fields.  The input data between the delimiters becomes the
      * fields themselves.


@@ -541,7 +540,7 @@ public:
      * This behavior differs from Java, which ignores capture groups.
      *
      *  For the best performance on split() operations,
      * This behavior differs from Java, which ignores capture groups.
      *
      *  For the best performance on split() operations,

-     *  <code>RegexMatcher::split</code> is preferable to this function
+     *  `RegexMatcher::split()` is preferable to this function

      *
      * @param input   The string to be split into fields.  The field delimiters
      *                match the pattern (in the "this" object)
      *
      * @param input   The string to be split into fields.  The field delimiters
      *                match the pattern (in the "this" object)


@@ -636,8 +635,9 @@ private:
     //
     //  Implementation Methods
     //
     //
     //  Implementation Methods
     //

-    void        init();            // Common initialization, for use by constructors.
-    void        zap();             // Common cleanup
+    void        init();                 // Common initialization, for use by constructors.
+    bool        initNamedCaptureMap();  // Lazy init for fNamedCaptureMap.
+    void        zap();                  // Common cleanup

 
     void        dumpOp(int32_t index) const;
 
 
     void        dumpOp(int32_t index) const;
 


@@ -674,8 +674,7 @@ public:
       * its matcher() method to create the RegexMatcher objects.
       *
       *  @param regexp The Regular Expression to be compiled.
       * its matcher() method to create the RegexMatcher objects.
       *
       *  @param regexp The Regular Expression to be compiled.

-      *  @param flags  Regular expression options, such as case insensitive matching.
-      *                @see UREGEX_CASE_INSENSITIVE
+      *  @param flags  #URegexpFlag options, such as #UREGEX_CASE_INSENSITIVE.

       *  @param status Any errors are reported by setting this UErrorCode variable.
       *  @stable ICU 2.6
       */
       *  @param status Any errors are reported by setting this UErrorCode variable.
       *  @stable ICU 2.6
       */


@@ -690,8 +689,7 @@ public:
       * its matcher() method to create the RegexMatcher objects.
       *
       *  @param regexp The regular expression to be compiled.
       * its matcher() method to create the RegexMatcher objects.
       *
       *  @param regexp The regular expression to be compiled.

-      *  @param flags  Regular expression options, such as case insensitive matching.
-      *                @see UREGEX_CASE_INSENSITIVE
+      *  @param flags  #URegexpFlag options, such as #UREGEX_CASE_INSENSITIVE.

       *  @param status Any errors are reported by setting this UErrorCode variable.
       *
       *  @stable ICU 4.6
       *  @param status Any errors are reported by setting this UErrorCode variable.
       *
       *  @stable ICU 4.6


@@ -705,7 +703,7 @@ public:
       * created for the same expression, it will be more efficient to
       * separately create and cache a RegexPattern object, and use
       * its matcher() method to create the RegexMatcher objects.
       * created for the same expression, it will be more efficient to
       * separately create and cache a RegexPattern object, and use
       * its matcher() method to create the RegexMatcher objects.

-      * <p>
+      *

       * The matcher will retain a reference to the supplied input string, and all regexp
       * pattern matching operations happen directly on the original string.  It is
       * critical that the string not be altered or deleted before use by the regular
       * The matcher will retain a reference to the supplied input string, and all regexp
       * pattern matching operations happen directly on the original string.  It is
       * critical that the string not be altered or deleted before use by the regular


@@ -714,8 +712,7 @@ public:
       *  @param regexp The Regular Expression to be compiled.
       *  @param input  The string to match.  The matcher retains a reference to the
       *                caller's string; mo copy is made.
       *  @param regexp The Regular Expression to be compiled.
       *  @param input  The string to match.  The matcher retains a reference to the
       *                caller's string; mo copy is made.

-      *  @param flags  Regular expression options, such as case insensitive matching.
-      *                @see UREGEX_CASE_INSENSITIVE
+      *  @param flags  #URegexpFlag options, such as #UREGEX_CASE_INSENSITIVE.

       *  @param status Any errors are reported by setting this UErrorCode variable.
       *  @stable ICU 2.6
       */
       *  @param status Any errors are reported by setting this UErrorCode variable.
       *  @stable ICU 2.6
       */


@@ -729,7 +726,7 @@ public:
       * created for the same expression, it will be more efficient to
       * separately create and cache a RegexPattern object, and use
       * its matcher() method to create the RegexMatcher objects.
       * created for the same expression, it will be more efficient to
       * separately create and cache a RegexPattern object, and use
       * its matcher() method to create the RegexMatcher objects.

-      * <p>
+      *

       * The matcher will make a shallow clone of the supplied input text, and all regexp
       * pattern matching operations happen on this clone.  While read-only operations on
       * the supplied text are permitted, it is critical that the underlying string not be
       * The matcher will make a shallow clone of the supplied input text, and all regexp
       * pattern matching operations happen on this clone.  While read-only operations on
       * the supplied text are permitted, it is critical that the underlying string not be


@@ -737,8 +734,7 @@ public:
       *
       *  @param regexp The Regular Expression to be compiled.
       *  @param input  The string to match.  The matcher retains a shallow clone of the text.
       *
       *  @param regexp The Regular Expression to be compiled.
       *  @param input  The string to match.  The matcher retains a shallow clone of the text.

-      *  @param flags  Regular expression options, such as case insensitive matching.
-      *                @see UREGEX_CASE_INSENSITIVE
+      *  @param flags  #URegexpFlag options, such as #UREGEX_CASE_INSENSITIVE.

       *  @param status Any errors are reported by setting this UErrorCode variable.
       *
       *  @stable ICU 4.6
       *  @param status Any errors are reported by setting this UErrorCode variable.
       *
       *  @stable ICU 4.6


@@ -751,13 +747,12 @@ private:
      * Cause a compilation error if an application accidentally attempts to
      *   create a matcher with a (char16_t *) string as input rather than
      *   a UnicodeString.    Avoids a dangling reference to a temporary string.
      * Cause a compilation error if an application accidentally attempts to
      *   create a matcher with a (char16_t *) string as input rather than
      *   a UnicodeString.    Avoids a dangling reference to a temporary string.

-     * <p>
+     *

      * To efficiently work with char16_t *strings, wrap the data in a UnicodeString
      * using one of the aliasing constructors, such as
      * To efficiently work with char16_t *strings, wrap the data in a UnicodeString
      * using one of the aliasing constructors, such as

-     * <code>UnicodeString(UBool isTerminated, const char16_t *text, int32_t textLength);</code>
+     * `UnicodeString(UBool isTerminated, const char16_t *text, int32_t textLength);`

      * or in a UText, using
      * or in a UText, using

-     * <code>utext_openUChars(UText *ut, const char16_t *text, int64_t textLength, UErrorCode *status);</code>
-     *
+     * `utext_openUChars(UText *ut, const char16_t *text, int64_t textLength, UErrorCode *status);`

      */
     RegexMatcher(const UnicodeString &regexp, const char16_t *input,
         uint32_t flags, UErrorCode &status);
      */
     RegexMatcher(const UnicodeString &regexp, const char16_t *input,
         uint32_t flags, UErrorCode &status);


@@ -800,8 +795,8 @@ public:
     *   always starts at the beginning of the input region;
     *   unlike that function, it does not require that the entire region be matched.
     *
     *   always starts at the beginning of the input region;
     *   unlike that function, it does not require that the entire region be matched.
     *

-    *   <p>If the match succeeds then more information can be obtained via the <code>start()</code>,
-    *     <code>end()</code>, and <code>group()</code> functions.</p>
+    *   If the match succeeds then more information can be obtained via the start(),
+    *   end(), and group() functions.

     *
     *    @param   status     A reference to a UErrorCode to receive any errors.
     *    @return  TRUE if there is a match at the start of the input string.
     *
     *    @param   status     A reference to a UErrorCode to receive any errors.
     *    @return  TRUE if there is a match at the start of the input string.


@@ -815,8 +810,8 @@ public:
     *   The match may be of any length, and is not required to extend to the end
     *   of the input string.  Contrast with match().
     *
     *   The match may be of any length, and is not required to extend to the end
     *   of the input string.  Contrast with match().
     *

-    *   <p>If the match succeeds then more information can be obtained via the <code>start()</code>,
-    *     <code>end()</code>, and <code>group()</code> functions.</p>
+    *   If the match succeeds then more information can be obtained via the start(),
+    *   end(), and group() functions.

     *
     *    @param   startIndex The input string (native) index at which to begin matching.
     *    @param   status     A reference to a UErrorCode to receive any errors.
     *
     *    @param   startIndex The input string (native) index at which to begin matching.
     *    @param   status     A reference to a UErrorCode to receive any errors.


@@ -830,11 +825,11 @@ public:
     *  Find the next pattern match in the input string.
     *  The find begins searching the input at the location following the end of
     *  the previous match, or at the start of the string if there is no previous match.
     *  Find the next pattern match in the input string.
     *  The find begins searching the input at the location following the end of
     *  the previous match, or at the start of the string if there is no previous match.

-    *  If a match is found, <code>start(), end()</code> and <code>group()</code>
+    *  If a match is found, `start()`, `end()` and `group()`

     *  will provide more information regarding the match.
     *  will provide more information regarding the match.

-    *  <p>Note that if the input string is changed by the application,
+    *  Note that if the input string is changed by the application,

     *     use find(startPos, status) instead of find(), because the saved starting
     *     use find(startPos, status) instead of find(), because the saved starting

-    *     position may not be valid with the altered input string.</p>
+    *     position may not be valid with the altered input string.

     *  @return  TRUE if a match is found.
     *  @stable ICU 2.4
     */
     *  @return  TRUE if a match is found.
     *  @stable ICU 2.4
     */


@@ -845,11 +840,12 @@ public:
     *  Find the next pattern match in the input string.
     *  The find begins searching the input at the location following the end of
     *  the previous match, or at the start of the string if there is no previous match.
     *  Find the next pattern match in the input string.
     *  The find begins searching the input at the location following the end of
     *  the previous match, or at the start of the string if there is no previous match.

-    *  If a match is found, <code>start(), end()</code> and <code>group()</code>
+    *  If a match is found, `start()`, `end()` and `group()`

     *  will provide more information regarding the match.
     *  will provide more information regarding the match.

-    *  <p>Note that if the input string is changed by the application,
-    *     use find(startPos, status) instead of find(), because the saved starting
-    *     position may not be valid with the altered input string.</p>
+    *
+    *  Note that if the input string is changed by the application,
+    *  use find(startPos, status) instead of find(), because the saved starting
+    *  position may not be valid with the altered input string.

     *  @param   status  A reference to a UErrorCode to receive any errors.
     *  @return  TRUE if a match is found.
     * @stable ICU 55
     *  @param   status  A reference to a UErrorCode to receive any errors.
     *  @return  TRUE if a match is found.
     * @stable ICU 55


@@ -1079,10 +1075,10 @@ public:
     *   The effect is to remove any memory of previous matches,
     *       and to cause subsequent find() operations to begin at
     *       the specified (native) position in the input string.
     *   The effect is to remove any memory of previous matches,
     *       and to cause subsequent find() operations to begin at
     *       the specified (native) position in the input string.

-    * <p>
+    *

     *   The matcher's region is reset to its default, which is the entire
     *   input string.
     *   The matcher's region is reset to its default, which is the entire
     *   input string.

-    * <p>
+    *

     *   An alternative to this function is to set a match region
     *   beginning at the desired index.
     *
     *   An alternative to this function is to set a match region
     *   beginning at the desired index.
     *


@@ -1159,12 +1155,12 @@ private:
      * Cause a compilation error if an application accidentally attempts to
      *   reset a matcher with a (char16_t *) string as input rather than
      *   a UnicodeString.    Avoids a dangling reference to a temporary string.
      * Cause a compilation error if an application accidentally attempts to
      *   reset a matcher with a (char16_t *) string as input rather than
      *   a UnicodeString.    Avoids a dangling reference to a temporary string.

-     * <p>
+     *

      * To efficiently work with char16_t *strings, wrap the data in a UnicodeString
      * using one of the aliasing constructors, such as
      * To efficiently work with char16_t *strings, wrap the data in a UnicodeString
      * using one of the aliasing constructors, such as

-     * <code>UnicodeString(UBool isTerminated, const char16_t *text, int32_t textLength);</code>
+     * `UnicodeString(UBool isTerminated, const char16_t *text, int32_t textLength);`

      * or in a UText, using
      * or in a UText, using

-     * <code>utext_openUChars(UText *ut, const char16_t *text, int64_t textLength, UErrorCode *status);</code>
+     * `utext_openUChars(UText *ut, const char16_t *text, int64_t textLength, UErrorCode *status);`

      *
      */
     RegexMatcher &reset(const char16_t *input);
      *
      */
     RegexMatcher &reset(const char16_t *input);


@@ -1413,15 +1409,15 @@ public:
     * the pattern with the replacement string.   This is a convenience
     * function that provides a complete find-and-replace operation.
     *
     * the pattern with the replacement string.   This is a convenience
     * function that provides a complete find-and-replace operation.
     *

-    * <p>This function first resets this RegexMatcher. It then scans the input string
+    * This function first resets this RegexMatcher. It then scans the input string

     * looking for a match of the pattern. Input that is not part
     * of the match is appended directly to the result string; the match is replaced
     * in the result by the replacement string. The replacement string may contain
     * looking for a match of the pattern. Input that is not part
     * of the match is appended directly to the result string; the match is replaced
     * in the result by the replacement string. The replacement string may contain

-    * references to captured groups.</p>
+    * references to captured groups.

     *
     *

-    * <p>The state of the matcher (the position at which a subsequent find()
+    * The state of the matcher (the position at which a subsequent find()

     *    would begin) after completing a replaceFirst() is not specified.  The
     *    would begin) after completing a replaceFirst() is not specified.  The

-    *    RegexMatcher should be reset before doing additional find() operations.</p>
+    *    RegexMatcher should be reset before doing additional find() operations.

     *
     *    @param   replacement a string containing the replacement text.
     *    @param   status      a reference to a UErrorCode to receive any errors.
     *
     *    @param   replacement a string containing the replacement text.
     *    @param   status      a reference to a UErrorCode to receive any errors.


@@ -1436,15 +1432,15 @@ public:
     * the pattern with the replacement string.   This is a convenience
     * function that provides a complete find-and-replace operation.
     *
     * the pattern with the replacement string.   This is a convenience
     * function that provides a complete find-and-replace operation.
     *

-    * <p>This function first resets this RegexMatcher. It then scans the input string
+    * This function first resets this RegexMatcher. It then scans the input string

     * looking for a match of the pattern. Input that is not part
     * of the match is appended directly to the result string; the match is replaced
     * in the result by the replacement string. The replacement string may contain
     * looking for a match of the pattern. Input that is not part
     * of the match is appended directly to the result string; the match is replaced
     * in the result by the replacement string. The replacement string may contain

-    * references to captured groups.</p>
+    * references to captured groups.

     *
     *

-    * <p>The state of the matcher (the position at which a subsequent find()
+    * The state of the matcher (the position at which a subsequent find()

     *    would begin) after completing a replaceFirst() is not specified.  The
     *    would begin) after completing a replaceFirst() is not specified.  The

-    *    RegexMatcher should be reset before doing additional find() operations.</p>
+    *    RegexMatcher should be reset before doing additional find() operations.

     *
     *    @param   replacement a string containing the replacement text.
     *    @param   dest        a mutable UText in which the results are placed.
     *
     *    @param   replacement a string containing the replacement text.
     *    @param   dest        a mutable UText in which the results are placed.


@@ -1462,13 +1458,13 @@ public:
     *   Implements a replace operation intended to be used as part of an
     *   incremental find-and-replace.
     *
     *   Implements a replace operation intended to be used as part of an
     *   incremental find-and-replace.
     *

-    *   <p>The input string, starting from the end of the previous replacement and ending at
+    *   The input string, starting from the end of the previous replacement and ending at

     *   the start of the current match, is appended to the destination string.  Then the
     *   replacement string is appended to the output string,
     *   the start of the current match, is appended to the destination string.  Then the
     *   replacement string is appended to the output string,

-    *   including handling any substitutions of captured text.</p>
+    *   including handling any substitutions of captured text.

     *
     *

-    *   <p>For simple, prepackaged, non-incremental find-and-replace
-    *   operations, see replaceFirst() or replaceAll().</p>
+    *   For simple, prepackaged, non-incremental find-and-replace
+    *   operations, see replaceFirst() or replaceAll().

     *
     *   @param   dest        A UnicodeString to which the results of the find-and-replace are appended.
     *   @param   replacement A UnicodeString that provides the text to be substituted for
     *
     *   @param   dest        A UnicodeString to which the results of the find-and-replace are appended.
     *   @param   replacement A UnicodeString that provides the text to be substituted for


@@ -1493,13 +1489,13 @@ public:
     *   Implements a replace operation intended to be used as part of an
     *   incremental find-and-replace.
     *
     *   Implements a replace operation intended to be used as part of an
     *   incremental find-and-replace.
     *

-    *   <p>The input string, starting from the end of the previous replacement and ending at
+    *   The input string, starting from the end of the previous replacement and ending at

     *   the start of the current match, is appended to the destination string.  Then the
     *   replacement string is appended to the output string,
     *   the start of the current match, is appended to the destination string.  Then the
     *   replacement string is appended to the output string,

-    *   including handling any substitutions of captured text.</p>
+    *   including handling any substitutions of captured text.

     *
     *

-    *   <p>For simple, prepackaged, non-incremental find-and-replace
-    *   operations, see replaceFirst() or replaceAll().</p>
+    *   For simple, prepackaged, non-incremental find-and-replace
+    *   operations, see replaceFirst() or replaceAll().

     *
     *   @param   dest        A mutable UText to which the results of the find-and-replace are appended.
     *                         Must not be NULL.
     *
     *   @param   dest        A mutable UText to which the results of the find-and-replace are appended.
     *                         Must not be NULL.


@@ -1523,8 +1519,8 @@ public:
    /**
     * As the final step in a find-and-replace operation, append the remainder
     * of the input string, starting at the position following the last appendReplacement(),
    /**
     * As the final step in a find-and-replace operation, append the remainder
     * of the input string, starting at the position following the last appendReplacement(),

-    * to the destination string. <code>appendTail()</code> is intended to be invoked after one
-    * or more invocations of the <code>RegexMatcher::appendReplacement()</code>.
+    * to the destination string. `appendTail()` is intended to be invoked after one
+    * or more invocations of the `RegexMatcher::appendReplacement()`.

     *
     *  @param dest A UnicodeString to which the results of the find-and-replace are appended.
     *  @return  the destination string.
     *
     *  @param dest A UnicodeString to which the results of the find-and-replace are appended.
     *  @return  the destination string.


@@ -1536,8 +1532,8 @@ public:
    /**
     * As the final step in a find-and-replace operation, append the remainder
     * of the input string, starting at the position following the last appendReplacement(),
    /**
     * As the final step in a find-and-replace operation, append the remainder
     * of the input string, starting at the position following the last appendReplacement(),

-    * to the destination string. <code>appendTail()</code> is intended to be invoked after one
-    * or more invocations of the <code>RegexMatcher::appendReplacement()</code>.
+    * to the destination string. `appendTail()` is intended to be invoked after one
+    * or more invocations of the `RegexMatcher::appendReplacement()`.

     *
     *  @param dest A mutable UText to which the results of the find-and-replace are appended.
     *               Must not be NULL.
     *
     *  @param dest A mutable UText to which the results of the find-and-replace are appended.
     *               Must not be NULL.


@@ -1550,7 +1546,7 @@ public:
 
 
     /**
 
 
     /**

-     * Split a string into fields.  Somewhat like split() from Perl.
+     * Split a string into fields.  Somewhat like %split() from Perl.

      * The pattern matches identify delimiters that separate the input
      *  into fields.  The input data between the matches becomes the
      *  fields themselves.
      * The pattern matches identify delimiters that separate the input
      *  into fields.  The input data between the matches becomes the
      *  fields themselves.


@@ -1579,7 +1575,7 @@ public:
 
 
     /**
 
 
     /**

-     * Split a string into fields.  Somewhat like split() from Perl.
+     * Split a string into fields.  Somewhat like %split() from Perl.

      * The pattern matches identify delimiters that separate the input
      *  into fields.  The input data between the matches becomes the
      *  fields themselves.
      * The pattern matches identify delimiters that separate the input
      *  into fields.  The input data between the matches becomes the
      *  fields themselves.


@@ -1614,14 +1610,14 @@ public:
     *   infinite loop.
     *   When a limit is set a match operation will fail with an error if the
     *   limit is exceeded.
     *   infinite loop.
     *   When a limit is set a match operation will fail with an error if the
     *   limit is exceeded.

-    *   <p>
+    *

     *   The units of the limit are steps of the match engine.
     *   Correspondence with actual processor time will depend on the speed
     *   of the processor and the details of the specific pattern, but will
     *   typically be on the order of milliseconds.
     *   The units of the limit are steps of the match engine.
     *   Correspondence with actual processor time will depend on the speed
     *   of the processor and the details of the specific pattern, but will
     *   typically be on the order of milliseconds.

-    *   <p>
+    *

     *   By default, the matching time is not limited.
     *   By default, the matching time is not limited.

-    *   <p>
+    *

     *
     *   @param   limit       The limit value, or 0 for no limit.
     *   @param   status      A reference to a UErrorCode to receive any errors.
     *
     *   @param   limit       The limit value, or 0 for no limit.
     *   @param   status      A reference to a UErrorCode to receive any errors.


@@ -1640,16 +1636,16 @@ public:
   /**
     *  Set the amount of heap storage available for use by the match backtracking stack.
     *  The matcher is also reset, discarding any results from previous matches.
   /**
     *  Set the amount of heap storage available for use by the match backtracking stack.
     *  The matcher is also reset, discarding any results from previous matches.

-    *  <p>
+    *

     *  ICU uses a backtracking regular expression engine, with the backtrack stack
     *  maintained on the heap.  This function sets the limit to the amount of memory
     *  ICU uses a backtracking regular expression engine, with the backtrack stack
     *  maintained on the heap.  This function sets the limit to the amount of memory

-    *  that can be used  for this purpose.  A backtracking stack overflow will
+    *  that can be used for this purpose.  A backtracking stack overflow will

     *  result in an error from the match operation that caused it.
     *  result in an error from the match operation that caused it.

-    *  <p>
+    *

     *  A limit is desirable because a malicious or poorly designed pattern can use
     *  excessive memory, potentially crashing the process.  A limit is enabled
     *  by default.
     *  A limit is desirable because a malicious or poorly designed pattern can use
     *  excessive memory, potentially crashing the process.  A limit is enabled
     *  by default.

-    *  <p>
+    *

     *  @param limit  The maximum size, in bytes, of the matching backtrack stack.
     *                A value of zero means no limit.
     *                The limit must be greater or equal to zero.
     *  @param limit  The maximum size, in bytes, of the matching backtrack stack.
     *                A value of zero means no limit.
     *                The limit must be greater or equal to zero.


@@ -1882,7 +1878,8 @@ private:
 };
 
 U_NAMESPACE_END
 };
 
 U_NAMESPACE_END

-#endif // U_SHOW_CPLUSPLUS_API
-

 #endif  // UCONFIG_NO_REGULAR_EXPRESSIONS
 #endif  // UCONFIG_NO_REGULAR_EXPRESSIONS

+
+#endif /* U_SHOW_CPLUSPLUS_API */
+

 #endif
 #endif