SOLR-10607: Improve RTimerTree documentation

2017-05-04 08:10:30 -07:00 · 2017-05-04 08:10:30 -07:00 · 2af2b55e2d
parent 5eb4a8d71b
commit 2af2b55e2d
1 changed files with 4 additions and 3 deletions
--- a/solr/core/src/java/org/apache/solr/util/RTimerTree.java
+++ b/solr/core/src/java/org/apache/solr/util/RTimerTree.java
@ -51,9 +51,10 @@ public class RTimerTree extends RTimer {
    return new RTimerTree();
  }

-  /** Create new subtimer with given name
-   *
-   * Subtimer will be started.
+  /**
+   * Returns a subtimer given its name.
+   * If the subtimer did not exist a new subtimer will be started and returned,
+   * otherwise an existing subtimer will be returned as-is.
   */
  public RTimerTree sub(String desc) {
    RTimerTree child = children.get( desc );