Added comment about returned iterator.

5cript · 5cript · commit 14bc2159919f · 2025-08-09T12:18:15.000+02:00
diff --git a/include/interval-tree/interval_tree.hpp b/include/interval-tree/interval_tree.hpp
@@ -1126,6 +1126,7 @@ namespace lib_interval_tree
          *  inserted with more overlap searches? If the result is a single interval shall it insert_overlap or insert?
          *  Be careful to not produce overlapping merge sets when doing recursive insertion, or it will recurse
          *  endlessly.
+         *  @return An iterator to the inserted or merged interval.
          */
         iterator insert_overlap(interval_type const& ival, bool exclusive = false, bool recursive = true)
         {

Original file line number	Diff line number	Diff line change
`@@ -1126,6 +1126,7 @@ namespace lib_interval_tree`
`1126`	`1126`	`* inserted with more overlap searches? If the result is a single interval shall it insert_overlap or insert?`
`1127`	`1127`	`* Be careful to not produce overlapping merge sets when doing recursive insertion, or it will recurse`
`1128`	`1128`	`* endlessly.`
	`1129`	`+ * @return An iterator to the inserted or merged interval.`
`1129`	`1130`	`*/`
`1130`	`1131`	`iterator insert_overlap(interval_type const& ival, bool exclusive = false, bool recursive = true)`
`1131`	`1132`	`{`