added documentation for ToExistingArray

TheHippo · TheHippo · commit 35c9afa40a19 · 2025-04-08T17:35:26.000+02:00
diff --git a/roaring.go b/roaring.go
@@ -438,6 +438,9 @@ func (rb *Bitmap) toArray(array *[]uint32) *[]uint32 {
 	return array
 }
 
+// ToExistingArray stores all of the integers stored in the Bitmap in sorted order in the
+// slice that is given to ToExistingArray. It is the callers duty to make sure the slice
+// has the right size.
 func (rb *Bitmap) ToExistingArray(array *[]uint32) *[]uint32 {
 	return rb.toArray(array)
 }

Original file line number	Diff line number	Diff line change
`@@ -438,6 +438,9 @@ func (rb Bitmap) toArray(array []uint32) *[]uint32 {`
`438`	`438`	`return array`
`439`	`439`	`}`
`440`	`440`
	`441`	`+// ToExistingArray stores all of the integers stored in the Bitmap in sorted order in the`
	`442`	`+// slice that is given to ToExistingArray. It is the callers duty to make sure the slice`
	`443`	`+// has the right size.`
`441`	`444`	`func (rb Bitmap) ToExistingArray(array []uint32) *[]uint32 {`
`442`	`445`	`return rb.toArray(array)`
`443`	`446`	`}`