DevTools: Add JSDoc for static methods, fix JSDoc types and induced errors

Source/devtools/front_end/timeline/TimelineUIUtils.js

 /*
  * Copyright (C) 2013 Google Inc. All rights reserved.
  * Copyright (C) 2012 Intel Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are
  * met:
  *
  *     * Redistributions of source code must retain the above copyright
  * notice, this list of conditions and the following disclaimer.
@@ skipping 15 matching lines @@
  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
 /**
  */
 WebInspector.TimelineUIUtils = function() { }
 
+/**
+ * @return {!Object.<string, !WebInspector.TimelineCategory>}
+ */
 WebInspector.TimelineUIUtils.categories = function()
 {
     if (WebInspector.TimelineUIUtils._categories)
         return WebInspector.TimelineUIUtils._categories;
     WebInspector.TimelineUIUtils._categories = {
         loading: new WebInspector.TimelineCategory("loading", WebInspector.UIString("Loading"), 0, "hsl(214, 53%, 58%)", "hsl(214, 67%, 90%)", "hsl(214, 67%, 74%)", "hsl(214, 67%, 66%)"),
         scripting: new WebInspector.TimelineCategory("scripting", WebInspector.UIString("Scripting"), 1, "hsl(43, 90%, 45%)", "hsl(43, 83%, 90%)", "hsl(43, 83%, 72%)", "hsl(43, 83%, 64%) "),
         rendering: new WebInspector.TimelineCategory("rendering", WebInspector.UIString("Rendering"), 2, "hsl(256, 50%, 60%)", "hsl(256, 67%, 90%)", "hsl(256, 67%, 76%)", "hsl(256, 67%, 70%)"),
         painting: new WebInspector.TimelineCategory("painting", WebInspector.UIString("Painting"), 2, "hsl(109, 33%, 47%)", "hsl(109, 33%, 90%)", "hsl(109, 33%, 64%)", "hsl(109, 33%, 55%)"),
         other: new WebInspector.TimelineCategory("other", WebInspector.UIString("Other"), -1, "hsl(0, 0%, 73%)", "hsl(0, 0%, 90%)", "hsl(0, 0%, 87%)", "hsl(0, 0%, 79%)"),
@@ skipping 101 matching lines @@
  * @param {!WebInspector.TimelineModel.Record} record
  * @return {!WebInspector.TimelineCategory}
  */
 WebInspector.TimelineUIUtils.categoryForRecord = function(record)
 {
     return WebInspector.TimelineUIUtils.recordStyle(record).category;
 }
 
 /**
  * @param {!WebInspector.TimelineModel.Record} record
+ * @return {boolean}
  */
 WebInspector.TimelineUIUtils.isEventDivider = function(record)
 {
     var recordTypes = WebInspector.TimelineModel.RecordType;
     if (record.type() === recordTypes.TimeStamp)
         return true;
     if (record.type() === recordTypes.MarkFirstPaint)
         return true;
     if (record.type() === recordTypes.MarkDOMContent || record.type() === recordTypes.MarkLoad)
         return record.data()["isMainFrame"];
@@ skipping 16 matching lines @@
     case recordTypes.ResourceFinish:
         return true;
     default:
         return false;
     }
 }
 
 /**
  * @param {string} recordType
  * @param {string=} title
+ * @return {!Element}
  */
 WebInspector.TimelineUIUtils.createEventDivider = function(recordType, title)
 {
     var eventDivider = document.createElement("div");
     eventDivider.className = "resources-event-divider";
     var recordTypes = WebInspector.TimelineModel.RecordType;
 
     if (recordType === recordTypes.MarkDOMContent)
         eventDivider.className += " resources-blue-divider";
     else if (recordType === recordTypes.MarkLoad)
@@ skipping 160 matching lines @@
          var rowElement = footerElement.createChild("div");
          rowElement.createChild("div", "timeline-aggregated-category timeline-" + category.name);
          rowElement.createTextChild(WebInspector.UIString("%s %s", formatter(value), category.title));
     }
     return element;
 }
 
 /**
  * @param {!WebInspector.TimelineFrameModel} frameModel
  * @param {!WebInspector.TimelineFrame} frame
+ * @return {!Element}
  */
 WebInspector.TimelineUIUtils.generatePopupContentForFrame = function(frameModel, frame)
 {
     var contentHelper = new WebInspector.TimelinePopupContentHelper(WebInspector.UIString("Frame"));
     var durationInMillis = frame.endTime - frame.startTime;
     var durationText = WebInspector.UIString("%s (at %s)", Number.millisToString(frame.endTime - frame.startTime, true),
         Number.millisToString(frame.startTimeOffset, true));
     contentHelper.appendTextRow(WebInspector.UIString("Duration"), durationText);
     contentHelper.appendTextRow(WebInspector.UIString("FPS"), Math.floor(1000 / durationInMillis));
     contentHelper.appendTextRow(WebInspector.UIString("CPU time"), Number.millisToString(frame.cpuTime, true));
     contentHelper.appendElementRow(WebInspector.UIString("Aggregated Time"),
         WebInspector.TimelineUIUtils._generateAggregatedInfo(frame.timeByCategory));
     if (WebInspector.experimentsSettings.layersPanel.isEnabled() && frame.layerTree) {
         contentHelper.appendElementRow(WebInspector.UIString("Layer tree"),
                                        WebInspector.Linkifier.linkifyUsingRevealer(frame.layerTree, WebInspector.UIString("show")));
     }
     return contentHelper.contentTable();
 }
 
 /**
  * @param {!WebInspector.FrameStatistics} statistics
+ * @return {!Element}
  */
 WebInspector.TimelineUIUtils.generatePopupContentForFrameStatistics = function(statistics)
 {
     /**
      * @param {number} time
      */
     function formatTimeAndFPS(time)
     {
         return WebInspector.UIString("%s (%.0f FPS)", Number.millisToString(time, true), 1 / time);
     }
 
     var contentHelper = new WebInspector.TimelineDetailsContentHelper(null, null, false);
     contentHelper.appendTextRow(WebInspector.UIString("Minimum Time"), formatTimeAndFPS(statistics.minDuration));
     contentHelper.appendTextRow(WebInspector.UIString("Average Time"), formatTimeAndFPS(statistics.average));
     contentHelper.appendTextRow(WebInspector.UIString("Maximum Time"), formatTimeAndFPS(statistics.maxDuration));
     contentHelper.appendTextRow(WebInspector.UIString("Standard Deviation"), Number.millisToString(statistics.stddev, true));
 
     return contentHelper.element;
 }
 
 /**
  * @param {!CanvasRenderingContext2D} context
  * @param {number} width
  * @param {number} height
  * @param {string} color0
  * @param {string} color1
  * @param {string} color2
+ * @return {!CanvasGradient}
  */
 WebInspector.TimelineUIUtils.createFillStyle = function(context, width, height, color0, color1, color2)
 {
     var gradient = context.createLinearGradient(0, 0, width, height);
     gradient.addColorStop(0, color0);
     gradient.addColorStop(0.25, color1);
     gradient.addColorStop(0.75, color1);
     gradient.addColorStop(1, color2);
     return gradient;
 }
 
 /**
  * @param {!CanvasRenderingContext2D} context
  * @param {number} width
  * @param {number} height
  * @param {!WebInspector.TimelineCategory} category
+ * @return {!CanvasGradient}
  */
 WebInspector.TimelineUIUtils.createFillStyleForCategory = function(context, width, height, category)
 {
     return WebInspector.TimelineUIUtils.createFillStyle(context, width, height, category.fillColorStop0, category.fillColorStop1, category.borderColor);
 }
 
 /**
  * @param {!WebInspector.TimelineCategory} category
+ * @return {string}
  */
 WebInspector.TimelineUIUtils.createStyleRuleForCategory = function(category)
 {
     var selector = ".timeline-category-" + category.name + " .timeline-graph-bar, " +
         ".panel.timeline .timeline-filters-header .filter-checkbox-filter.filter-checkbox-filter-" + category.name + " .checkbox-filter-checkbox, " +
         ".popover .timeline-" + category.name + ", " +
         ".timeline-details-view .timeline-" + category.name + ", " +
         ".timeline-category-" + category.name + " .timeline-tree-icon"
 
     return selector + " { background-image: linear-gradient(" +
@@ skipping 546 matching lines @@
         for (var i = 0; i < stackTrace.length; ++i) {
             var stackFrame = stackTrace[i];
             var row = stackTraceElement.createChild("div");
             row.createTextChild(stackFrame.functionName || WebInspector.UIString("(anonymous function)"));
             row.createTextChild(" @ ");
             var urlElement = this._linkifier.linkifyLocation(this._target, stackFrame.url, stackFrame.lineNumber - 1);
             row.appendChild(urlElement);
         }
     }
 }