948823 - [JSDOC] Refine all not-jsdoc-friendly comments in nfc handover manager

Status: RESOLVED FIXED

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

Comment 1

[Kamil Leszczuk [:kamituel]]

Attachment: Pull request

This pull requests fixes comments and renames all private methods to have "_" (underscore) prefix.

This is the first step to make NfcHandoverManager instantiable. Once it get's approved, I'll do the second part (more intrusive) - refactor to be instantiable - in bug 971519.

All unit tests are passing. I've also manually tested it with both emulator and Flame, and handovers are working after applying this patch.

Comments are generating correctly using "grunt docs".

Comment 2

[Greg Weng [:snowmantw][:gweng][:λ]]

Comment on attachment 8451246 [details] [review]
Pull request

Documenting, renaming and there is no obvious errors Thanks.

Comment 3

[Carsten Book [:Tomcat]]

master: https://github.com/mozilla-b2g/gaia/commit/9f8d380019c8116153f12557bace3ec65f3a3b64

Comment 4

[Kamil Leszczuk [:kamituel]]

Comment on attachment 8451246 [details] [review]
Pull request

NOTE: Please see https://wiki.mozilla.org/Release_Management/B2G_Landing to better understand the B2G approval process and landings.

[Approval Request Comment]
[Bug caused by] (feature/regressing bug #): Uplift of 998175 was requested (it's blocking 2.0), and it's easiest to first uplift this one to cleanly apply 998175.
[User impact] if declined: There will be more problematic uplift of 998175.
[Testing completed]: Unit tests passes, and manually tested NFC handovers on Flame.
[Risk to taking this patch] (and alternatives if risky): Don't know any, changes are pretty minor.
[String changes made]:

Comment 5

[Ryan VanderMeulen [:RyanVM]]

v2.0: https://github.com/mozilla-b2g/gaia/commit/351d6c295ce210510d0b0210fc830989193d751e