Closed Bug 1278733 Opened 3 years ago Closed 3 years ago

Enable JSDoc validation in WebExtension code

Categories

(WebExtensions :: Untriaged, defect)

defect
Not set

Tracking

(firefox50 fixed)

RESOLVED FIXED
mozilla50
Tracking Status
firefox50 --- fixed

People

(Reporter: kmag, Assigned: kmag)

Details

Attachments

(1 file)

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.
Attachment #8761024 - Flags: review?(aswan) → review+
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?
https://reviewboard.mozilla.org/r/58380/#review55290

> change this to match the changed signature below?

Oops. Good catch.
https://hg.mozilla.org/integration/fx-team/rev/8c8ac2b6adbd574b0930dc97d17932224b7dc604
Bug 1278733: Turn on JSDoc validation, and fix basic errors in existing comments. r=aswan
https://hg.mozilla.org/integration/fx-team/rev/4c902c5433c7c10b07b302ec856b4789a2fef65d
Bug 1278733: Follow-up: Fix JSDoc errors in the subprocess module. r=bustage
https://hg.mozilla.org/mozilla-central/rev/8c8ac2b6adbd
https://hg.mozilla.org/mozilla-central/rev/4c902c5433c7
Status: NEW → RESOLVED
Closed: 3 years ago
Resolution: --- → FIXED
Target Milestone: --- → mozilla50
Product: Toolkit → WebExtensions
You need to log in before you can comment on or make changes to this bug.