ICU-13194 RBBI monkey test, add description of run parameters.

X-SVN-Rev: 41165

diff --git a/icu4c/source/test/intltest/rbbimonkeytest.h b/icu4c/source/test/intltest/rbbimonkeytest.h
index 83b16f3c6cd6615b0751f48423ff6aeeb5dbce20..616a6d84311e722e16a99a5a6529a6e365cabe03 100644 (file)
--- a/icu4c/source/test/intltest/rbbimonkeytest.h
+++ b/icu4c/source/test/intltest/rbbimonkeytest.h
@@ -25,6 +25,20 @@
 #include "uhash.h"
 #include "uvector.h"
 
+// RBBI Monkey Test. Run break iterators against randomly generated strings, compare results with
+//                   an independent reference implementation.
+//
+//         The monkey test can be run with parameters, e.g.
+//              intltest rbbi/RBBIMonkeyTest@loop=-1,rules=word.txt
+//         will run word break testing in an infinite loop.
+//         Summary of options
+//               test=name             Test against the named reference rule file.
+//                                     Files are found in source/test/testdata/break_rules
+//               loop=nnn              Loop nnn times. -1 for no limit. loop of 1 is useful for debugging.
+//               seed=nnnn             Random number generator seed. Allows recreation of a failure.
+//                                     Error messages include the necessary seed value.
+//               verbose               Display details of a failure. Useful for debugging. Use with loop=1.
+//               expansions            Debug option, show expansions of rules and sets.
 //
 //  TODO:
 //     Develop a tailoring format.