more doc strings/comments

Author: alyst

src/regions.jl

@@ -135,6 +135,8 @@ center(a::Rect{T,N}) where {T,N} =
     end
 
 """
+    intersects(a::Region{T,N}, b::Region{T,N}) where {T,N}
+
 Check whether `a` intersects with `b`.
 """
 @generated intersects(a::Rect{T,N}, b::Rect{T,N}) where {T,N} =
@@ -143,7 +145,9 @@ Check whether `a` intersects with `b`.
     end
 
 """
-Check whether `b` is contained inside `a`.
+    contains(a::Region{T,N}, b::Region{T,N}) where {T,N}
+
+Check whether `a` contains `b`.
 """
 @generated contains(a::Rect{T,N}, b::Rect{T,N}) where {T,N} =
     quote
@@ -156,6 +160,8 @@ Check whether `b` is contained inside `a`.
     end
 
 """
+    in(a::Region{T,N}, b::Region{T,N}) where {T,N}
+
 Check whether `a` is contained inside `b`.
 """
 Base.in(a::Rect, b::Rect) = contains(b, a)
@@ -166,6 +172,8 @@ Base.:(==)(a::Point, b::Rect) = a.coord == b.low == b.high
 Base.:(==)(a::Rect, b::Point) = b == a
 
 """
+    touches(a::Rect{T,N}, b::Rect{T,N}) where {T,N}
+
 Check whether `a` and `b` touch
 (i.e. any `low` side touches `low` or `high` touches `high`).
 """

src/rtree/check.jl

@@ -1,6 +1,12 @@
 nelements(node::Leaf) = length(node)
 nelements(node::Branch) = sum(nelements, children(node))
 
+# check the R-tree node (branch or leaf):
+# * the parent
+# * the level
+# * the number of attached elements
+# * element id uniqueness
+# * the MBR (should fit the MBR of children)
 function check(node::Node{T,N,V}, tree::RTree{T,N,V},
                nnodes_perlevel::AbstractVector{Int}, ids::Union{Set, Nothing}) where {T,N,V}
     nnodes_perlevel[level(node) + 1] += 1
@@ -28,7 +34,7 @@ function check(node::Node{T,N,V}, tree::RTree{T,N,V},
 end
 
 # check the tree:
-# * the parent
+# * the root
 # * the height
 # * the number of elements
 # * the number of nodes per level

src/rtree/delete.jl

@@ -9,7 +9,7 @@ function Base.delete!(tree::RTree{T,N}, br::Rect{T,N}, id::Any = nothing) where
     leafx = findleaf(tree, br, id)
     leafx === nothing && __spatial_keyerror(eltype(tree), br, id)
     _detach!(leafx[1], leafx[2], tree)
-    tmpdetached = Vector{nodetype(tree)}() # FIXME Union{Leaf,Branch} ?
+    tmpdetached = Vector{nodetype(tree)}() # FIXME use pool, Union{Leaf,Branch} ?
     _condense!(leafx[1], tree, tmpdetached)
     _reinsert!(tree, tmpdetached)
     tree.nelems -= 1