1278733 - Enable JSDoc validation in WebExtension code

Status: RESOLVED FIXED

(WebExtensions :: Untriaged, defect)

Description

[Kris Maglione [:kmag]]

We should start by enforcing basic JSDoc validity, and eventually move to requiring JSDoc comments where they make sense, and valid parameter and return descriptions everywhere.

Comment 1

[Kris Maglione [:kmag]]

Attachment: Bug 1278733: Turn on JSDoc validation, and fix basic errors in existing comments.

Review commit: https://reviewboard.mozilla.org/r/58380/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/58380/

Comment 2

[Andrew Swan [:aswan]]

Comment on attachment 8761024 [details]
Bug 1278733: Turn on JSDoc validation, and fix basic errors in existing comments.

https://reviewboard.mozilla.org/r/58380/#review55290

::: toolkit/modules/addons/WebNavigation.jsm:103
(Diff revision 1)
> +   * @param {string} topic
> +   * @param {string} data
>     */
>    observe: function(subject, topic, data) {
>      if (topic == "autocomplete-did-enter-text") {
>        this.onURLBarAutoCompletion(subject, topic, data);

change this to match the changed signature below?

Comment 3

[Kris Maglione [:kmag]]

https://reviewboard.mozilla.org/r/58380/#review55290

> change this to match the changed signature below?

Oops. Good catch.

Comment 4

[Kris Maglione [:kmag]]

https://hg.mozilla.org/integration/fx-team/rev/8c8ac2b6adbd574b0930dc97d17932224b7dc604
Bug 1278733: Turn on JSDoc validation, and fix basic errors in existing comments. r=aswan

Comment 5

[Kris Maglione [:kmag]]

https://hg.mozilla.org/integration/fx-team/rev/4c902c5433c7c10b07b302ec856b4789a2fef65d
Bug 1278733: Follow-up: Fix JSDoc errors in the subprocess module. r=bustage

Comment 6

[Carsten Book [:Tomcat]]

https://hg.mozilla.org/mozilla-central/rev/8c8ac2b6adbd
https://hg.mozilla.org/mozilla-central/rev/4c902c5433c7