Add doxygen notes for regex

2015-05-25 22:09:32 +08:00 · 2015-05-25 22:09:32 +08:00 · 3c9ceb32a5
commit 3c9ceb32a5
parent 0934803ae1
1 changed files with 10 additions and 0 deletions
--- a/include/rapidjson/internal/regex.h
+++ b/include/rapidjson/internal/regex.h
@ -30,6 +30,16 @@ namespace internal {

 static const SizeType kRegexInvalidState = ~SizeType(0);  //!< Represents an invalid index in GenericRegex::State::out, out1

+//! Regular expression engine.
+/*!
+    Supported regular expression syntax:
+    - \c ab  Concatenation
+    - \c a|b   Alternation
+    - \c a?    Zero or one
+    - \c a*    Zero or more
+    - \c a+    One or more
+    - \c (ab)* Parenthesis grouping
+*/
 template <typename Encoding, typename Allocator = CrtAllocator>
 class GenericRegex {
 public: