1195343 - document RuleModificationList

Status: RESOLVED FIXED

(DevTools :: Inspector, defect)

Description

[Tom Tromey :tromey]

As part of bug 984880 I noticed that RuleModificationList doesn't
have documentation comments.

Comment 1

[Tom Tromey :tromey]

Attachment: update RuleModificationList comments

Comment 2

[Patrick Brosset <:pbro>]

Comment on attachment 8648755 [details] [diff] [review]
update RuleModificationList comments

Review of attachment 8648755 [details] [diff] [review]:
-----------------------------------------------------------------

Thanks for clarifying the doc for this class.
The jsdoc syntax needs some updates, but nothing that requires me to review the patch again, so r=me with those fixed.

::: toolkit/devtools/server/actors/styles.js
@@ +1455,5 @@
>   */
>  let RuleModificationList = Class({
> +  /**
> +   * Initialize a RuleModificationList.
> +   * @param rule {StyleRuleFront} the associated rule

There's a jsdoc validator rule in ESLint but unfortunately it has some problems so I've had to turn it off for now. We should revisit this in some time. Anyway, this to say that jsdoc comment have a specific syntax and I think it's:

@param {Type} paramName Description

So here it should instead be:

@param {StyleRuleFront} rule The associated rule.

Same comment for other params further in the file.

@@ +1465,5 @@
>  
> +  /**
> +   * Apply the modifications in this object to the associated rule.
> +   *
> +   * @return a promise which will be resolved when the modifications

I think it also helps documenting the return type:

@return {Promise} A promise which will be resolved ...

Comment 3

[Tom Tromey :tromey]

Attachment: update RuleModificationList comments

Updated per review.

Comment 4

[Tom Tromey :tromey]

This is just some comment additions in a .js file, so I believe it doesn't
need a try build.

Comment 5

[Pulsebot]

https://hg.mozilla.org/integration/fx-team/rev/f6aaf8d447d3

Comment 6

[Wes Kocher (:KWierso) (Not reading bugmail; email directly if needed)]

https://hg.mozilla.org/integration/fx-team/rev/f6aaf8d447d3

Comment 7

[Wes Kocher (:KWierso) (Not reading bugmail; email directly if needed)]

https://hg.mozilla.org/mozilla-central/rev/f6aaf8d447d3