Closed Bug 1170460 Opened 8 years ago Closed 8 years ago

[Keyboard] fix remain jsdoc error

Categories

(Firefox OS Graveyard :: Gaia::Keyboard, defect)

Product:
Firefox OS Graveyard
Component:
Gaia::Keyboard
Platform:
ARM
Gonk (Firefox OS)
Type:
defect
Priority:
Not set
Severity:
normal

Tracking

(Not tracked)

Status:
RESOLVED FIXED

People

(Reporter: gasolin, Assigned: nils, Mentored)

References

Details

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

Attachments

(1 file)

[gaia] Gioyik:bug-1170460 > mozilla-b2g:master
46 bytes, text/x-github-pull-request
gasolin
: review+
Details | Review 
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
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)
Thats normal. Please check apps/keyboard/jsdoc.json file and remove the files in exclude field.
Flags: needinfo?(gasolin)
@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! :)
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)
Comment on attachment 8638122 [details] [review]
[gaia] Gioyik:bug-1170460 > mozilla-b2g:master

Tests fine. Thanks for contribution!
Attachment #8638122 - Flags: review?(gasolin) → review+
merged https://github.com/mozilla-b2g/gaia/commit/a0e9f965b62a72df2a926d40b192db2960d9466c

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