⚠ Archived content — this site is no longer maintained.   Current WebKit documentation is at docs.webkit.org.

Changeset 117755 in webkit


Ignore:
Timestamp:
May 21, 2012, 3:44:10 AM (14 years ago)
Author:
apavlov@chromium.org
Message:

Web Inspector: Annotate CSSStyleModel.js for the closure compiler
​https://bugs.webkit.org/show_bug.cgi?id=86858

Reviewed by Yury Semikhatsky.

  • inspector/front-end/CSSStyleModel.js:

(WebInspector.CSSStyleDeclaration.parseComputedStylePayload):
(WebInspector.CSSStyleDeclaration.prototype.newBlankProperty):
(WebInspector.CSSStyleDeclaration.prototype.insertPropertyAt):
(WebInspector.CSSProperty.parsePayload):
(WebInspector.CSSProperty.prototype.setText):
(WebInspector.CSSProperty.prototype.setDisabled):
(WebInspector.CSSStyleSheet.prototype.setText):
(WebInspector.CSSStyleModelResourceBinding.prototype._innerSetContent.callbackWrapper):
(WebInspector.CSSStyleModelResourceBinding.prototype._innerSetContent):
(WebInspector.CSSStyleModelResourceBinding.prototype._loadStyleSheetHeaders):

Location:
trunk/Source/WebCore
Files:
2 edited

Legend:

Unmodified
Added
Removed

  • trunk/Source/WebCore/ChangeLog

    r117754 r117755  
     12012-05-21  Alexander Pavlov  <apavlov@chromium.org>
     2
     3        Web Inspector: Annotate CSSStyleModel.js for the closure compiler
     4        https://bugs.webkit.org/show_bug.cgi?id=86858
     5
     6        Reviewed by Yury Semikhatsky.
     7
     8        * inspector/front-end/CSSStyleModel.js:
     9        (WebInspector.CSSStyleDeclaration.parseComputedStylePayload):
     10        (WebInspector.CSSStyleDeclaration.prototype.newBlankProperty):
     11        (WebInspector.CSSStyleDeclaration.prototype.insertPropertyAt):
     12        (WebInspector.CSSProperty.parsePayload):
     13        (WebInspector.CSSProperty.prototype.setText):
     14        (WebInspector.CSSProperty.prototype.setDisabled):
     15        (WebInspector.CSSStyleSheet.prototype.setText):
     16        (WebInspector.CSSStyleModelResourceBinding.prototype._innerSetContent.callbackWrapper):
     17        (WebInspector.CSSStyleModelResourceBinding.prototype._innerSetContent):
     18        (WebInspector.CSSStyleModelResourceBinding.prototype._loadStyleSheetHeaders):
     19
    1202012-05-21  Rakesh KN  <rakesh.kn@motorola.com>
    221

  • trunk/Source/WebCore/inspector/front-end/CSSStyleModel.js

    r113707 r117755  
    4343}
    4444
     45/**
     46 * @param {Array.<CSSAgent.CSSRule>} ruleArray
     47 */
    4548WebInspector.CSSStyleModel.parseRuleArrayPayload = function(ruleArray)
    4649{
    … …  
    169172         * @param {DOMAgent.NodeId} nodeId
    170173         * @param {function(WebInspector.CSSRule, boolean)} successCallback
    171          * @param {*} rulePayload
     174         * @param {CSSAgent.CSSRule} rulePayload
    172175         * @param {?Array.<DOMAgent.NodeId>} selectedNodeIds
    173176         */
    … …  
    187190         * @param {?Protocol.Error} error
    188191         * @param {string} newSelector
    189          * @param {*=} rulePayload
     192         * @param {?CSSAgent.CSSRule} rulePayload
    190193         */
    191194        function callback(nodeId, successCallback, failureCallback, newSelector, error, rulePayload)
    … …  
    216219    addRule: function(nodeId, selector, successCallback, failureCallback)
    217220    {
     221        /**
     222         * @param {DOMAgent.NodeId} nodeId
     223         * @param {function(WebInspector.CSSRule, boolean)} successCallback
     224         * @param {CSSAgent.CSSRule} rulePayload
     225         * @param {?Array.<DOMAgent.NodeId>} selectedNodeIds
     226         */
    218227        function checkAffectsCallback(nodeId, successCallback, rulePayload, selectedNodeIds)
    219228        {
    … …  
    258267    },
    259268
     269    /**
     270     * @param {DOMAgent.NodeId} nodeId
     271     */
    260272    _ownerDocumentId: function(nodeId)
    261273    {
    … …  
    266278    },
    267279
     280    /**
     281     * @param {CSSAgent.StyleSheetId} styleSheetId
     282     */
    268283    _fireStyleSheetChanged: function(styleSheetId)
    269284    {
    … …  
    279294    },
    280295
     296    /**
     297     * @param {CSSAgent.StyleSheetId} styleSheetId
     298     * @param {string} newText
     299     * @param {boolean} majorChange
     300     * @param {function(?string)} userCallback
     301     */
    281302    setStyleSheetText: function(styleSheetId, newText, majorChange, userCallback)
    282303    {
    … …  
    309330/**
    310331 * @constructor
    311  * @param {*} payload
     332 * @param {CSSAgent.CSSStyle} payload
    312333 */
    313334WebInspector.CSSStyleDeclaration = function(payload)
    … …  
    352373}
    353374
     375/**
     376 * @param {Array.<CSSAgent.ShorthandEntry>} shorthandEntries
     377 * @return {Object}
     378 */
    354379WebInspector.CSSStyleDeclaration.buildShorthandValueMap = function(shorthandEntries)
    355380{
    … …  
    360385}
    361386
     387/**
     388 * @param {CSSAgent.CSSStyle} payload
     389 * @return {WebInspector.CSSStyleDeclaration}
     390 */
    362391WebInspector.CSSStyleDeclaration.parsePayload = function(payload)
    363392{
    … …  
    365394}
    366395
     396/**
     397 * @param {Array.<CSSAgent.CSSComputedStyleProperty>} payload
     398 * @return {WebInspector.CSSStyleDeclaration}
     399 */
    367400WebInspector.CSSStyleDeclaration.parseComputedStylePayload = function(payload)
    368401{
    369     var newPayload = { cssProperties: [], shorthandEntries: [], width: "", height: "" };
     402    var newPayload = /** @type {CSSAgent.CSSStyle} */ { cssProperties: [], shorthandEntries: [], width: "", height: "" };
    370403    if (payload)
    371404        newPayload.cssProperties = payload;
    … …  
    380413    },
    381414
     415    /**
     416     * @param {string} name
     417     * @return {WebInspector.CSSProperty|undefined}
     418     */
    382419    getLiveProperty: function(name)
    383420    {
    … …  
    385422    },
    386423
     424    /**
     425     * @param {string} name
     426     * @return {string}
     427     */
    387428    getPropertyValue: function(name)
    388429    {
    … …  
    391432    },
    392433
     434    /**
     435     * @param {string} name
     436     * @return {string}
     437     */
    393438    getPropertyPriority: function(name)
    394439    {
    … …  
    397442    },
    398443
     444    /**
     445     * @param {string} name
     446     * @return {string}
     447     */
    399448    getPropertyShorthand: function(name)
    400449    {
    … …  
    403452    },
    404453
     454    /**
     455     * @param {string} name
     456     * @return {boolean}
     457     */
    405458    isPropertyImplicit: function(name)
    406459    {
    … …  
    409462    },
    410463
     464    /**
     465     * @return {string}
     466     */
    411467    styleTextWithShorthands: function()
    412468    {
    … …  
    440496    },
    441497
     498    /**
     499     * @param {string} name
     500     * @return {Array.<WebInspector.CSSProperty>}
     501     */
    442502    getLonghandProperties: function(name)
    443503    {
    … …  
    445505    },
    446506
     507    /**
     508     * @param {string} shorthandProperty
     509     * @return {string}
     510     */
    447511    getShorthandValue: function(shorthandProperty)
    448512    {
    … …  
    451515    },
    452516
     517    /**
     518     * @param {string} shorthandProperty
     519     * @return {?string}
     520     */
    453521    getShorthandPriority: function(shorthandProperty)
    454522    {
    … …  
    461529    },
    462530
     531    /**
     532     * @param {number} index
     533     * @return {?WebInspector.CSSProperty}
     534     */
    463535    propertyAt: function(index)
    464536    {
    … …  
    466538    },
    467539
     540    /**
     541     * @return {number}
     542     */
    468543    pastLastSourcePropertyIndex: function()
    469544    {
    … …  
    482557    {
    483558        index = (typeof index === "undefined") ? this.pastLastSourcePropertyIndex() : index;
    484         return new WebInspector.CSSProperty(this, index, "", "", "", "active", true, false, false, "");
    485     },
    486 
     559        return new WebInspector.CSSProperty(this, index, "", "", "", "active", true, false, "", "");
     560    },
     561
     562    /**
     563     * @param {number} index
     564     * @param {string} name
     565     * @param {string} value
     566     * @param {function(?WebInspector.CSSStyleDeclaration)} userCallback
     567     */
    487568    insertPropertyAt: function(index, name, value, userCallback)
    488569    {
     570        /**
     571         * @param {function(?WebInspector.CSSStyleDeclaration)} userCallback
     572         * @param {?string} error
     573         * @param {CSSAgent.CSSStyle} payload
     574         */
    489575        function callback(userCallback, error, payload)
    490576        {
    … …  
    501587        }
    502588
     589        if (!this.id)
     590            throw "No style id";
     591
    503592        WebInspector.cssModel._pendingCommandsMajorState.push(true);
    504593        CSSAgent.setPropertyText(this.id, index, name + ": " + value + ";", false, callback.bind(this, userCallback));
    505594    },
    506595
     596    /**
     597     * @param {string} name
     598     * @param {string} value
     599     * @param {function(?WebInspector.CSSStyleDeclaration)} userCallback
     600     */
    507601    appendProperty: function(name, value, userCallback)
    508602    {
    … …  
    513607/**
    514608 * @constructor
     609 * @param {CSSAgent.CSSRule} payload
    515610 */
    516611WebInspector.CSSRule = function(payload)
    … …  
    528623}
    529624
     625/**
     626 * @param {CSSAgent.CSSRule} payload
     627 * @return {WebInspector.CSSRule}
     628 */
    530629WebInspector.CSSRule.parsePayload = function(payload)
    531630{
    … …  
    557656/**
    558657 * @constructor
     658 * @param {?WebInspector.CSSStyleDeclaration} ownerStyle
     659 * @param {number} index
     660 * @param {string} name
     661 * @param {string} value
     662 * @param {?string} priority
     663 * @param {string} status
     664 * @param {boolean} parsedOk
     665 * @param {boolean} implicit
     666 * @param {string} shorthand
     667 * @param {?string=} text
    559668 */
    560669WebInspector.CSSProperty = function(ownerStyle, index, name, value, priority, status, parsedOk, implicit, shorthand, text)
    … …  
    572681}
    573682
     683/**
     684 * @param {?WebInspector.CSSStyleDeclaration} ownerStyle
     685 * @param {number} index
     686 * @param {CSSAgent.CSSProperty} payload
     687 * @return {WebInspector.CSSProperty}
     688 */
    574689WebInspector.CSSProperty.parsePayload = function(ownerStyle, index, payload)
    575690{
    … …  
    581696    // shorthandName: ""
    582697    var result = new WebInspector.CSSProperty(
    583         ownerStyle, index, payload.name, payload.value, payload.priority || "", payload.status || "style", ("parsedOk" in payload) ? payload.parsedOk : true, !!payload.implicit, payload.shorthandName || "", payload.text);
     698        ownerStyle, index, payload.name, payload.value, payload.priority || "", payload.status || "style", ("parsedOk" in payload) ? !!payload.parsedOk : true, !!payload.implicit, payload.shorthandName || "", payload.text);
    584699    return result;
    585700}
    … …  
    627742     * @param {boolean} majorChange
    628743     * @param {boolean} overwrite
    629      * @param {Function=} userCallback
     744     * @param {function(?WebInspector.CSSStyleDeclaration)=} userCallback
    630745     */
    631746    setText: function(propertyText, majorChange, overwrite, userCallback)
    632747    {
     748        /**
     749         * @param {?WebInspector.CSSStyleDeclaration} style
     750         */
    633751        function enabledCallback(style)
    634752        {
    … …  
    637755        }
    638756
     757        /**
     758         * @param {?string} error
     759         * @param {?CSSAgent.CSSStyle} stylePayload
     760         */
    639761        function callback(error, stylePayload)
    640762        {
    … …  
    663785            throw "No ownerStyle for property";
    664786
     787        if (!this.ownerStyle.id)
     788            throw "No owner style id";
     789
    665790        // An index past all the properties adds a new property to the style.
    666791        WebInspector.cssModel._pendingCommandsMajorState.push(majorChange);
    … …  
    672797     * @param {boolean} majorChange
    673798     * @param {boolean} overwrite
    674      * @param {Function=} userCallback
     799     * @param {function(?WebInspector.CSSStyleDeclaration)=} userCallback
    675800     */
    676801    setValue: function(newValue, majorChange, overwrite, userCallback)
    … …  
    680805    },
    681806
     807    /**
     808     * @param {boolean} disabled
     809     * @param {function(?WebInspector.CSSStyleDeclaration)=} userCallback
     810     */
    682811    setDisabled: function(disabled, userCallback)
    683812    {
    … …  
    687816            userCallback(this.ownerStyle);
    688817
     818        /**
     819         * @param {?string} error
     820         * @param {CSSAgent.CSSStyle} stylePayload
     821         */
    689822        function callback(error, stylePayload)
    690823        {
    … …  
    702835        }
    703836
     837        if (!this.ownerStyle.id)
     838            throw "No owner style id";
     839
    704840        WebInspector.cssModel._pendingCommandsMajorState.push(false);
    705841        CSSAgent.toggleProperty(this.ownerStyle.id, this.index, disabled, callback.bind(this));
    … …  
    709845/**
    710846 * @constructor
    711  * @param {*} payload
     847 * @param {CSSAgent.CSSMedia} payload
    712848 */
    713849WebInspector.CSSMedia = function(payload)
    … …  
    726862};
    727863
     864/**
     865 * @param {CSSAgent.CSSMedia} payload
     866 * @return {WebInspector.CSSMedia}
     867 */
    728868WebInspector.CSSMedia.parsePayload = function(payload)
    729869{
    … …  
    731871}
    732872
     873/**
     874 * @param {Array.<CSSAgent.CSSMedia>} payload
     875 * @return {Array.<WebInspector.CSSMedia>}
     876 */
    733877WebInspector.CSSMedia.parseMediaArrayPayload = function(payload)
    734878{
    … …  
    741885/**
    742886 * @constructor
     887 * @param {CSSAgent.CSSStyleSheetBody} payload
    743888 */
    744889WebInspector.CSSStyleSheet = function(payload)
    … …  
    757902}
    758903
     904/**
     905 * @param {CSSAgent.StyleSheetId} styleSheetId
     906 * @param {function(?WebInspector.CSSStyleSheet)} userCallback
     907 */
    759908WebInspector.CSSStyleSheet.createForId = function(styleSheetId, userCallback)
    760909{
     910    /**
     911     * @param {?string} error
     912     * @param {CSSAgent.CSSStyleSheetBody} styleSheetPayload
     913     */
    761914    function callback(error, styleSheetPayload)
    762915    {
    … …  
    770923
    771924WebInspector.CSSStyleSheet.prototype = {
     925    /**
     926     * @return {string|undefined}
     927     */
    772928    getText: function()
    773929    {
    … …  
    775931    },
    776932
     933    /**
     934     * @param {string} newText
     935     * @param {boolean} majorChange
     936     * @param {function(?string)=} userCallback
     937     */
    777938    setText: function(newText, majorChange, userCallback)
    778939    {
     940        /**
     941         * @param {?string} error
     942         */
    779943        function callback(error)
    780944        {
    … …  
    807971
    808972WebInspector.CSSStyleModelResourceBinding.prototype = {
     973    /**
     974     * @param {WebInspector.Resource} resource
     975     * @param {string} content
     976     * @param {boolean} majorChange
     977     * @param {function(?string)} userCallback
     978     */
    809979    setContent: function(resource, content, majorChange, userCallback)
    810980    {
    … …  
    819989    },
    820990
     991    /**
     992     * @return {boolean}
     993     */
    821994    canSetContent: function()
    822995    {
    … …  
    824997    },
    825998
     999    /**
     1000     * @param {WebInspector.Event} event
     1001     */
    8261002    _inspectedURLChanged: function(event)
    8271003    {
    … …  
    8311007    },
    8321008
     1009    /**
     1010     * @param {string} url
     1011     * @param {string} content
     1012     * @param {boolean} majorChange
     1013     * @param {function(?string)} userCallback
     1014     * @param {?string} error
     1015     */
    8331016    _innerSetContent: function(url, content, majorChange, userCallback, error)
    8341017    {
    … …  
    8401023        var styleSheetId = this._urlToStyleSheetId[url];
    8411024        if (!styleSheetId) {
    842             if (userCallback)
    843                 userCallback("No stylesheet found: " + url);
     1025            userCallback("No stylesheet found: " + url);
    8441026            return;
    8451027        }
    … …  
    8481030        function callbackWrapper(error)
    8491031        {
    850             if (userCallback)
    851                 userCallback(error);
     1032            userCallback(error);
    8521033            delete this._isSettingContent;
    8531034        }
    … …  
    8551036    },
    8561037
     1038    /**
     1039     * @param {function(?string)} callback
     1040     */
    8571041    _loadStyleSheetHeaders: function(callback)
    8581042    {
     1043        /**
     1044         * @param {?string} error
     1045         * @param {Array.<CSSAgent.CSSStyleSheetHeader>} infos
     1046         */
    8591047        function didGetAllStyleSheets(error, infos)
    8601048        {
    … …  
    8691057                this._styleSheetIdToURL[info.styleSheetId] = info.sourceURL;
    8701058            }
    871             callback();
     1059            callback(null);
    8721060        }
    8731061        CSSAgent.getAllStyleSheets(didGetAllStyleSheets.bind(this));
    8741062    },
    8751063
     1064    /**
     1065     * @param {WebInspector.Event} event
     1066     */
    8761067    _styleSheetChanged: function(event)
    8771068    {
    … …  
    8821073            return;
    8831074
     1075        /**
     1076         * @param {?string} error
     1077         * @param {string} content
     1078         */
    8841079        function callback(error, content)
    8851080        {
    … …  
    8901085    },
    8911086
     1087    /**
     1088     * @param {CSSAgent.StyleSheetId} styleSheetId
     1089     * @param {string} content
     1090     */
    8921091    _innerStyleSheetChanged: function(styleSheetId, content)
    8931092    {
    … …  
    9291128    },
    9301129
     1130    /**
     1131     * @param {CSSAgent.StyleSheetId} styleSheetId
     1132     */
    9311133    styleSheetChanged: function(styleSheetId)
    9321134    {
Note: See TracChangeset for help on using the changeset viewer.