[Keyboard] fix remain jsdoc error

RESOLVED FIXED

Status

Firefox OS
Gaia::Keyboard
RESOLVED FIXED
3 years ago
3 years ago

People

(Reporter: gasolin@mozilla.com, Assigned: nils, Mentored)

Tracking

Firefox Tracking Flags

(Not tracked)

Details

(Whiteboard: good-first-bug, zh, mozweekend)

Attachments

(1 attachment)

(Reporter)

Description

3 years ago
Since bug 1151765 has landed and support es6 syntax for jsdoc parsing, there're still some syntax issues not resolved in gaia.

We could solve jsdoc issues per-app.
Assigning to Nils for the MozWeekend in Berlin
Assignee: nobody → nils
Whiteboard: good-first-bug, zh → good-first-bug, zh, mozweekend
(Assignee)

Comment 2

3 years ago
I could not reproduce any syntax errors when running `gulp jsdoc:keyboard`. The only issues were warnings about the ES6 arrow expressions, like this:

"WARNING: JSDoc does not currently handle ArrowFunctionExpression nodes."

Also, the generated documentation does look okay.

What errors is this ticket about and how can they be produced?
Status: NEW → ASSIGNED
Flags: needinfo?(gasolin)
(Reporter)

Comment 3

3 years ago
Thats normal. Please check apps/keyboard/jsdoc.json file and remove the files in exclude field.
Flags: needinfo?(gasolin)

Comment 4

3 years ago
@nils I think, what gasolin is trying to say is, the problematic files are excludes from JSDoc generation by now. If you remove them from the exclude field in the mentioned jsdoc.json, you should see the the syntax errors.

Btw, was nice to meet you again! :)
Created attachment 8638122 [details] [review]
[gaia] Gioyik:bug-1170460 > mozilla-b2g:master
Fred, after remove the files in exclude field, no errors were found. I tested it and created a patch. Setting r? to a Keyboard owner module to see if this could be merged.
Attachment #8638122 - Flags: review?(timdream)
Comment on attachment 8638122 [details] [review]
[gaia] Gioyik:bug-1170460 > mozilla-b2g:master

I am not familiar w/ jsdocs related work.
Attachment #8638122 - Flags: review?(timdream) → review?(gasolin)
(Reporter)

Comment 8

3 years ago
Comment on attachment 8638122 [details] [review]
[gaia] Gioyik:bug-1170460 > mozilla-b2g:master

Tests fine. Thanks for contribution!
Attachment #8638122 - Flags: review?(gasolin) → review+
(Reporter)

Comment 9

3 years ago
merged https://github.com/mozilla-b2g/gaia/commit/a0e9f965b62a72df2a926d40b192db2960d9466c

Thanks!
Status: ASSIGNED → RESOLVED
Last Resolved: 3 years ago
Resolution: --- → FIXED
You need to log in before you can comment on or make changes to this bug.