mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-08-11 18:25:40 +02:00
Code Issues Wiki Activity

Bug 311416: Clarify javadoc

Browse source
This commit is contained in:
Marc Khouzam 2010-05-04 17:58:08 +00:00
parent 0c30d752e0
commit 45bb4086d0
1 changed files with 8 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
dsf/org.eclipse.cdt.dsf/src/org/eclipse/cdt/dsf/debug/service/IStack.java
View file

@ -1,5 +1,5 @@
/******************************************************************************* /*******************************************************************************
* Copyright (c) 2006,, 2008 Wind River Systems and others. * Copyright (c) 2006,, 2010 Wind River Systems and others.
* All rights reserved. This program and the accompanying materials * All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0 * are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at * which accompanies this distribution, and is available at
@ -129,11 +129,14 @@ public interface IStack extends IDsfService {
void getLocals(IFrameDMContext frameCtx, DataRequestMonitor<IVariableDMContext[]> rm); void getLocals(IFrameDMContext frameCtx, DataRequestMonitor<IVariableDMContext[]> rm);
/** /**
* Retrieves the number of stack frames available for the given context.. * Retrieves the number of stack frames available for the given context. The depth
* returned could, but is not required to, be limited to the maxDepth parameter.
*
* @param dmc Context to retrieve data for. * @param dmc Context to retrieve data for.
* @param The maximum depth of stack to calculate. Should be 0 to calculate * @param maxDepth The maximum depth of stack that is requested. If 0, not limit should
* depth with no limit. * be used to calculate the stack depth, and the actual stack depth should be returned.
* @param rm Callback * @param rm Request monitor indicating the current stack depth, potentially limited
* to maxDepth.
*/ */
void getStackDepth(IDMContext dmc, int maxDepth, DataRequestMonitor<Integer> rm); void getStackDepth(IDMContext dmc, int maxDepth, DataRequestMonitor<Integer> rm);
} }