update doxygen

Author: paul-szczepanek-arm

connectivity/FEATURE_BLE/source/generic/GapImpl.h

@@ -409,7 +409,7 @@ class Gap :
         /** Return pointer to the first element that fulfills the passed in condition and remove the entry
          * that was pointing to the item. Transfers ownership to caller.
          *
-         * @param compare_func The condition that is checked for all the items start from last put in.
+         * @param compare_func The condition that is checked for all the items.
          * @return First element that fulfills the passed in condition or nullptr if no such item found.
          */
         EventType* pop(mbed::Callback<bool(EventType&)> compare_func)
@@ -425,9 +425,12 @@ class Gap :
         }
 
         /** Return pointer to the first element that fulfills the passed in condition and remove the entry
-         * that was pointing to the item. Transfers ownership to caller.
+         * that was pointing to the item. Takes and returns number of failed matches allowing to speed up search.
+         * Transfers ownership to caller.
+         *
+         * @note Calls must be consecutive - any call to pop or find will invalidate the search.
          *
-         * @param compare_func The condition that is checked for all the items start from last put in.
+         * @param compare_func The condition that is checked for all the items.
          * @param events_not_matching Pointer to the number of items already searched but not matching.
          * This is updated in the method.
          * @return First element that fulfills the passed in condition or nullptr if no such item found.
@@ -448,7 +451,7 @@ class Gap :
 
         /** Return pointer to the first element that fulfills the passed in condition. Does not remove item from list.
          *
-         * @param compare_func The condition that is checked for all the items start from last put in.
+         * @param compare_func The condition that is checked for all the items.
          * @return First element that fulfills the passed in condition or nullptr if no such item found.
          */
         EventType* find(mbed::Callback<bool(EventType&)> compare_func)