From e8edc59cd13a78b4cd16a1e1f0918afbcfd24c82 Mon Sep 17 00:00:00 2001
From: Max Medvedev <maxim.medvedev@jetbrains.com>
Date: Thu, 18 Jan 2018 10:18:37 +0300
Subject: [PATCH] [type hierarchy] add a doc

---
 .../src/com/intellij/ide/util/treeView/NodeDescriptor.java   | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/platform/editor-ui-api/src/com/intellij/ide/util/treeView/NodeDescriptor.java b/platform/editor-ui-api/src/com/intellij/ide/util/treeView/NodeDescriptor.java
index 8b31cfe7e34e..f1601f816788 100644
--- a/platform/editor-ui-api/src/com/intellij/ide/util/treeView/NodeDescriptor.java
+++ b/platform/editor-ui-api/src/com/intellij/ide/util/treeView/NodeDescriptor.java
@@ -61,6 +61,11 @@ public abstract class NodeDescriptor<E> {
     myIndex = index;
   }
 
+  /**
+   * Make sure the descriptor is up to date with its content
+   *
+   * @return true if any descriptor's properties changed during the update
+   */
   public abstract boolean update();
 
   public abstract E getElement();