Francois Gouget : testbot: Document Collection::DeleteItem().

[Alexandre Julliard]

Module: tools
Branch: master
Commit: 942bf9d4885ccd0ba940aec95f3e26a0b905642b
URL:    http://source.winehq.org/git/tools.git/?a=commit;h=942bf9d4885ccd0ba940aec95...

Author: Francois Gouget <fgouget(a)codeweavers.com>
Date:   Fri Dec  8 04:20:24 2017 +0100

testbot: Document Collection::DeleteItem().

In particular note that it cascades to other tables that have foreign
keys to the row being deleted.

Signed-off-by: Francois Gouget <fgouget(a)codeweavers.com>
Signed-off-by: Alexandre Julliard <julliard(a)winehq.org>

---

 testbot/lib/ObjectModel/Collection.pm | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/testbot/lib/ObjectModel/Collection.pm b/testbot/lib/ObjectModel/Collection.pm
index 1b29ec1..6c1bd1d 100644
--- a/testbot/lib/ObjectModel/Collection.pm
+++ b/testbot/lib/ObjectModel/Collection.pm
@@ -550,6 +550,20 @@ sub GetMasterCols($)
   return ($self->{MasterColNames}, $self->{MasterColValues});
 }
 
+=pod
+=over 12
+
+=item C<DeleteItem()>
+
+Deletes the specified Item from the Collection and the database backing it.
+
+Note that if there are other tables with a foreign key referencing this item
+the corresponding rows will be deleted too. So for instance deleting a Job
+will also delete the Steps and Tasks it is composed of.
+
+=back
+=cut
+
 sub DeleteItem($$)
 {
   my ($self, $Item) = @_;