1193163 - [JSDOC] write documentation of smart-home in jsdoc format

Status: RESOLVED FIXED

(Firefox OS Graveyard :: Gaia::TV::Home, defect)

Description

[Tzu-Lin Huang [:dwi2][:tzhuang]]

We need documentation of app-deck in jsdoc format. We'll focus on filter and pin-to-home in this bug. That means we need to add documentation for the following files:
1. card_filter.js
2. filter_manager.js
3. message_handler.js
4. connection_manager.js

And also describe the architecture of smart-home in README.md

Comment 1

[GitHub Autolander Bot]

Attachment: [gaia] dwi2:bug1193163 > mozilla-b2g:master

Comment 2

[Tzu-Lin Huang [:dwi2][:tzhuang]]

Comment on attachment 8649074 [details] [review]
[gaia] dwi2:bug1193163 > mozilla-b2g:master

Hi Rex,

I added js doc for the following files

1. card_filter.js
2. filter_manager.js
3. message_handler.js
4. connection_manager.js

You could use |make docs| or |gulp jsdoc:smart-home| to generate js doc locally.
Also I fix some typo in jsdoc in other apps in tv_apps folder.

Please help to review it, thanks

Comment 3

[KM Lee [:rexboy] (inactivate after Sep. 22)]

Comment on attachment 8649074 [details] [review]
[gaia] dwi2:bug1193163 > mozilla-b2g:master

Looks good to me!

Comment 4

[Tzu-Lin Huang [:dwi2][:tzhuang]]

Thanks

Landed in master
https://github.com/mozilla-b2g/gaia/commit/86746c4db1810650644430d7797045721904cb61