Doc: Clarify QBitArray::fill() documentation

Fix a minor mistake in the the function parameter documentation,
and add a code snippet.

Task-number: QTBUG-39782
Change-Id: Ia5d88a983ad683ae5bde9f332d51adc4afda77a8
Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
Reviewed-by: Alex Blasche <alexander.blasche@digia.com>

1 files changed, 10 insertions, 3 deletions

diff --git a/src/corelib/tools/qbitarray.cpp b/src/corelib/tools/qbitarray.cpp
index a6f22abce8..9f7b2db526 100644
--- a/src/corelib/tools/qbitarray.cpp
+++ b/src/corelib/tools/qbitarray.cpp
@@ -290,11 +290,18 @@ void QBitArray::resize(int size)
 /*!
     \overload
 
-    Sets bits at index positions \a begin up to and excluding \a end
+    Sets bits at index positions \a begin up to (but not including) \a end
     to \a value.
 
-    \a begin and \a end must be a valid index position in the bit
-    array (i.e., 0 <= \a begin <= size() and 0 <= \a end <= size()).
+    \a begin must be a valid index position in the bit array
+    (0 <= \a begin < size()).
+
+    \a end must be either a valid index position or equal to size(), in
+    which case the fill operation runs until the end of the array
+    (0 <= \a end <= size()).
+
+    Example:
+    \snippet code/src_corelib_tools_qbitarray.cpp 15
 */
 
 void QBitArray::fill(bool value, int begin, int end)