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

Clarification of javadoc

Browse source 
Change-Id: Id543b62c92c354de3fec62e0044ed33ea1f30190
This commit is contained in:
Marc Khouzam 2014-08-07 11:39:22 -04:00
parent 041a00ea28
commit 3deafff15b
1 changed files with 15 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
dsf/org.eclipse.cdt.dsf.ui/src/org/eclipse/cdt/dsf/debug/ui/viewmodel/update/ElementFormatEvent.java
View file

@ -13,9 +13,9 @@ package org.eclipse.cdt.dsf.debug.ui.viewmodel.update;
import java.util.Set; import java.util.Set;
/** /**
* An event that indicates element format is changed. Even when a viewer is * An event that indicates the format of certain elements has changed.
* configured to be in a manual update mode, there is a need to update of the * Even when a viewer is configured to be in a manual update mode, there is a need to
* labels/states of the element. * update the labels/states of elements.
* *
* @since 2.2 * @since 2.2
*/ */
@ -25,21 +25,22 @@ public class ElementFormatEvent {
/** /**
* Constructor * Constructor
* @param elements the elements that have their formats changed * @param elems The set of elements that have their formats changed
* @param applyDepth how deep each of the elements apply to itself and their child elements. * @param depth The depth to which the change of format applies, with respect to the
* -1 - recursively apply child elements to an infinite depth; * affected elements and their children:
* 0 - does not apply to the element itself and its child elements; * -1 - recursively applies to the element and its children to an infinite depth;
* 1 - apply to the element itself only; * 0 - does not apply to the element itself or its children elements;
* 1 - applies to the element itself only;
* 2 - apply to the element, its direct children and grand-children; * 2 - apply to the element, its direct children and grand-children;
* and so on for other positive numbers. * and so on for other positive numbers.
*/ */
public ElementFormatEvent(Set<Object> elements, int applyDepth) { public ElementFormatEvent(Set<Object> elems, int depth) {
this.elements = elements; elements = elems;
this.applyDepth = applyDepth; applyDepth = depth;
} }
/** /**
* Get the elements that has formats changed. * Get the elements for which the format has changed.
* *
* @return the elements * @return the elements
*/ */
@ -48,8 +49,8 @@ public class ElementFormatEvent {
} }
/** /**
* Get the depth that how each of the elements apply to itself and their * Get the depth to which the change of format applies, with respect to the
* child elements. * affected elements and their children.
* *
* @return the apply depth. * @return the apply depth.
*/ */