From d6bcb20759251b8867a5683b091841524728daee Mon Sep 17 00:00:00 2001 From: John Cortell Date: Tue, 13 Feb 2007 13:08:05 +0000 Subject: [PATCH] Additional comments --- .../cdt/debug/core/cdi/model/ICDIMemorySpaceManagement.java | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/debug/org.eclipse.cdt.debug.core/cdi/org/eclipse/cdt/debug/core/cdi/model/ICDIMemorySpaceManagement.java b/debug/org.eclipse.cdt.debug.core/cdi/org/eclipse/cdt/debug/core/cdi/model/ICDIMemorySpaceManagement.java index 9a435b72b48..737dc9a1180 100644 --- a/debug/org.eclipse.cdt.debug.core/cdi/org/eclipse/cdt/debug/core/cdi/model/ICDIMemorySpaceManagement.java +++ b/debug/org.eclipse.cdt.debug.core/cdi/org/eclipse/cdt/debug/core/cdi/model/ICDIMemorySpaceManagement.java @@ -33,12 +33,16 @@ public interface ICDIMemorySpaceManagement extends ICDIObject { String addressToString(BigInteger address, String memorySpaceID); /** - * The inverse of addressToString + * The inverse of addressToString. Optionally decodes a memoryspace/address + * string to its components. Client must provide decoding if it provides + * encoding in addressToString. Conversely, it should return null if + * addressToString returns null. * * @param str - the encoded string (contains memory space + hex address value) * @param memorySpaceID_out the memory space ID * @return the BigInteger part of str; client should return null if the default decoding provided * by CDT is sufficient (:) + * @throws CDIException if string is not in the expected format */ BigInteger stringToAddress(String str, StringBuffer memorySpaceID_out) throws CDIException;