[CLOSED] [SplitView] Inconsistent documentation

[core-ai-bot]

Issue by redmunds
Tuesday Sep 09, 2014 at 15:04 GMT
Originally opened as adobe/brackets#9024

---

In WorkspaceManager.js, the refreshHint param is documented as a {string}, but the caller and callees which use that param document it as a {boolean}:

    /**
     * Calculates a new size for editor-holder and resizes it accordingly, then and dispatches the "workspaceUpdateLayout"
     * event. (The editors within are resized by EditorManager, in response to that event).
     * 
     *`@`param {string=} refreshHint  One of "skip", "force", or undefined. See EditorManager docs.
     */
    function triggerUpdateLayout(refreshHint) {
        // Find how much space is left for the editor
        var editorAreaHeight = calcAvailableHeight();

        $editorHolder.height(editorAreaHeight);  // affects size of "not-editor" placeholder as well

        // Resize editor to fill the space
        $(exports).trigger("workspaceUpdateLayout", [editorAreaHeight, refreshHint]);
    }

@JeffryBooher