Extra documentation concerning the functionality of opm_end and callbacks

diff --git a/doc/libopm-api.txt b/doc/libopm-api.txt
index 43813a831c98a05b1845b89b10e5032ecbf306cd..0f8e079a01713e0e792fb5175e63fc1e0026f213 100644 (file)
--- a/doc/libopm-api.txt
+++ b/doc/libopm-api.txt
@@ -265,7 +265,11 @@ void opm_scanend(OPM_T *, OPM_REMOTE_T *)
    struct exists, but it is also known that the scan has already active.
    Using opm_scanend will save time by not traversing the queue list.
 
-
+   IMPORTANT: If the opm_end function ends any scans in the queue, the
+              OPM_CALLBACK_END callback will be called immadiately for
+              those scans. Any scans in the active scan list will be set
+              OPM_STATE_CLOSED and OPM_CALLBACK_END for those scans will
+              be called on the next opm_cycle.
 
 
 OPM_ERR_T opm_callback(OPM_T *, int, OPM_CALLBACK_T, void *)