ia64/xen-unstable
changeset 7575:c774efa2aca8
Added doccomment.
Signed-off-by: Ewan Mellor <ewan@xensource.com>
Signed-off-by: Ewan Mellor <ewan@xensource.com>
author | emellor@leeni.uk.xensource.com |
---|---|
date | Sun Oct 30 17:19:35 2005 +0100 (2005-10-30) |
parents | e212c0b60fbe |
children | d49fd494963e |
files | tools/python/xen/xend/server/DevController.py |
line diff
1.1 --- a/tools/python/xen/xend/server/DevController.py Sun Oct 30 17:17:21 2005 +0100 1.2 +++ b/tools/python/xen/xend/server/DevController.py Sun Oct 30 17:19:35 2005 +0100 1.3 @@ -69,9 +69,15 @@ class DevController: 1.4 def destroyDevice(self, devid): 1.5 """Destroy the specified device. 1.6 1.7 - The implementation here simply deletes the appropriate paths from 1.8 - the store. This may be overridden by subclasses who need to perform 1.9 - other tasks on destruction. 1.10 + @param devid The device ID, or something device-specific from which 1.11 + the device ID can be determined (such as a guest-side device name). 1.12 + 1.13 + The implementation here simply deletes the appropriate paths from the 1.14 + store. This may be overridden by subclasses who need to perform other 1.15 + tasks on destruction. Further, the implementation here can only 1.16 + accept integer device IDs, or values that can be converted to 1.17 + integers. Subclasses may accept other values and convert them to 1.18 + integers before passing them here. 1.19 """ 1.20 1.21 devid = int(devid)