[Xen-changelog] Added doccomment.

[Xen patchbot -unstable <patchbot-unstable@xxxxxxxxxxxxxxxxxxx>]

# HG changeset patch
# User emellor@xxxxxxxxxxxxxxxxxxxxxx
# Node ID c774efa2aca84e715d3f863c4c8ec1798dd56924
# Parent  e212c0b60fbef5563a860b90eb06eebc795f862a
Added doccomment.

Signed-off-by: Ewan Mellor <ewan@xxxxxxxxxxxxx>

diff -r e212c0b60fbe -r c774efa2aca8 
tools/python/xen/xend/server/DevController.py
--- a/tools/python/xen/xend/server/DevController.py     Sun Oct 30 16:17:21 2005
+++ b/tools/python/xen/xend/server/DevController.py     Sun Oct 30 16:19:35 2005
@@ -69,9 +69,15 @@
     def destroyDevice(self, devid):
         """Destroy the specified device.
 
-        The implementation here simply deletes the appropriate paths from
-        the store.  This may be overridden by subclasses who need to perform
-        other tasks on destruction.
+        @param devid The device ID, or something device-specific from which
+        the device ID can be determined (such as a guest-side device name).
+
+        The implementation here simply deletes the appropriate paths from the
+        store.  This may be overridden by subclasses who need to perform other
+        tasks on destruction.  Further, the implementation here can only
+        accept integer device IDs, or values that can be converted to
+        integers.  Subclasses may accept other values and convert them to
+        integers before passing them here.
         """
 
         devid = int(devid)

_______________________________________________
Xen-changelog mailing list
Xen-changelog@xxxxxxxxxxxxxxxxxxx
http://lists.xensource.com/xen-changelog