Comments about no_arg in the C++ wrapper.

git-svn-id: svn://vcs.exim.org/pcre/code/trunk@390 2f5784b3-3f2a-0410-8824-cb99058d5e15

1 files changed, 8 insertions, 2 deletions

diff --git a/pcrecpp.h b/pcrecpp.h
index a87a816..7e79703 100644
--- a/pcrecpp.h
+++ b/pcrecpp.h
@@ -646,9 +646,15 @@ class PCRECPP_EXP_DEFN RE {
   // regexp wasn't valid on construction.
   int NumberOfCapturingGroups() const;
 
-  // The default value for an argument, to indicate no arg was passed in
+  // The default value for an argument, to indicate the end of the argument 
+  // list. This must be used only in optional argument defaults. It should NOT
+  // be passed explicitly. Some people have tried to use it like this:
+  //
+  //   FullMatch(x, y, &z, no_arg, &w);
+  //
+  // This is a mistake, and will not work.
   static Arg no_arg;
-
+  
  private:
 
   void Init(const string& pattern, const RE_Options* options);