{"action":"created","comment":{"url":"https://api.github.com/repos/LiskHQ/lisk/pulls/comments/167840382","pull_request_review_id":96113971,"id":167840382,"diff_hunk":"@@ -0,0 +1,17 @@\n+/**\n+ * @namespace helpers\n+ * @property {module:helpers/bson} BSON\n+ * @property {module:helpers/cache} Cache\n+ * @property {module:helpers/config} Config\n+ * @property {module:helpers/diff} Diff\n+ * @property {module:helpers/ed} Ed\n+ * @property {module:helpers/git} Git\n+ * @property {module:helpers/http_api} HTTP_API\n+ * @property {module:helpers/jobs_queue} Jobs_queue\n+ * @property {module:helpers/slots} Slots\n+ * @property {module:helpers/sort_by} Sort_by\n+ * @property {module:helpers/swagger} Swagger\n+ * @property {module:helpers/swagger_module_registry} Swagger_module_registry\n+ * @property {module:helpers/ws_api} WS_API\n+ * @property {module:helpers/z_schema} Z_schema\n+ */","path":"helpers/index.js","position":17,"original_position":17,"commit_id":"aac4d88d8ab4b82e19aba5171fa367cab44e1e1f","original_commit_id":"aac4d88d8ab4b82e19aba5171fa367cab44e1e1f","user":{"login":"Tschakki","id":1993505,"avatar_url":"https://avatars2.githubusercontent.com/u/1993505?v=4","gravatar_id":"","url":"https://api.github.com/users/Tschakki","html_url":"https://github.com/Tschakki","followers_url":"https://api.github.com/users/Tschakki/followers","following_url":"https://api.github.com/users/Tschakki/following{/other_user}","gists_url":"https://api.github.com/users/Tschakki/gists{/gist_id}","starred_url":"https://api.github.com/users/Tschakki/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Tschakki/subscriptions","organizations_url":"https://api.github.com/users/Tschakki/orgs","repos_url":"https://api.github.com/users/Tschakki/repos","events_url":"https://api.github.com/users/Tschakki/events{/privacy}","received_events_url":"https://api.github.com/users/Tschakki/received_events","type":"User","site_admin":false},"body":"It only includes the modules. \r\nClasses and namespaces can have a `@memberof parent` tag, which will include them to the parent.","created_at":"2018-02-13T11:49:45Z","updated_at":"2018-02-13T11:49:45Z","html_url":"https://github.com/LiskHQ/lisk/pull/1532#discussion_r167840382","pull_request_url":"https://api.github.com/repos/LiskHQ/lisk/pulls/1532","author_association":"MEMBER","_links":{"self":{"href":"https://api.github.com/repos/LiskHQ/lisk/pulls/comments/167840382"},"html":{"href":"https://github.com/LiskHQ/lisk/pull/1532#discussion_r167840382"},"pull_request":{"href":"https://api.github.com/repos/LiskHQ/lisk/pulls/1532"}},"in_reply_to_id":167798074},"pull_request":{"url":"https://api.github.com/repos/LiskHQ/lisk/pulls/1532","id":167729043,"html_url":"https://github.com/LiskHQ/lisk/pull/1532","diff_url":"https://github.com/LiskHQ/lisk/pull/1532.diff","patch_url":"https://github.com/LiskHQ/lisk/pull/1532.patch","issue_url":"https://api.github.com/repos/LiskHQ/lisk/issues/1532","number":1532,"state":"open","locked":false,"title":"Standardize code documentation in helpers/* - Closes #1481","user":{"login":"Tschakki","id":1993505,"avatar_url":"https://avatars2.githubusercontent.com/u/1993505?v=4","gravatar_id":"","url":"https://api.github.com/users/Tschakki","html_url":"https://github.com/Tschakki","followers_url":"https://api.github.com/users/Tschakki/followers","following_url":"https://api.github.com/users/Tschakki/following{/other_user}","gists_url":"https://api.github.com/users/Tschakki/gists{/gist_id}","starred_url":"https://api.github.com/users/Tschakki/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Tschakki/subscriptions","organizations_url":"https://api.github.com/users/Tschakki/orgs","repos_url":"https://api.github.com/users/Tschakki/repos","events_url":"https://api.github.com/users/Tschakki/events{/privacy}","received_events_url":"https://api.github.com/users/Tschakki/received_events","type":"User","site_admin":false},"body":"### What was the problem?\r\nCode documentation standards are not applied consistently in the project.\r\n\r\n### How did I fix it?\r\nApply the same JSDoc standards in every file.\r\n\r\n### How to test it?\r\n`npm run docs:build`\r\n`npm run docs:serve`\r\n\r\n### Review checklist\r\n\r\n* The PR solves #1481 \r\n* All new code is covered with unit tests\r\n* All new code was formatted with Prettier\r\n* Linting passes\r\n* Tests pass\r\n* Commit messages follow the [commit guidelines](CONTRIBUTING.md#git-commit-messages)\r\n* Documentation has been added/updated\r\n","created_at":"2018-02-07T15:45:05Z","updated_at":"2018-02-13T11:49:45Z","closed_at":null,"merged_at":null,"merge_commit_sha":"c005a82c43e9979658984b9a62511e9f73117217","assignee":{"login":"karmacoma","id":8068,"avatar_url":"https://avatars0.githubusercontent.com/u/8068?v=4","gravatar_id":"","url":"https://api.github.com/users/karmacoma","html_url":"https://github.com/karmacoma","followers_url":"https://api.github.com/users/karmacoma/followers","following_url":"https://api.github.com/users/karmacoma/following{/other_user}","gists_url":"https://api.github.com/users/karmacoma/gists{/gist_id}","starred_url":"https://api.github.com/users/karmacoma/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/karmacoma/subscriptions","organizations_url":"https://api.github.com/users/karmacoma/orgs","repos_url":"https://api.github.com/users/karmacoma/repos","events_url":"https://api.github.com/users/karmacoma/events{/privacy}","received_events_url":"https://api.github.com/users/karmacoma/received_events","type":"User","site_admin":false},"assignees":[{"login":"karmacoma","id":8068,"avatar_url":"https://avatars0.githubusercontent.com/u/8068?v=4","gravatar_id":"","url":"https://api.github.com/users/karmacoma","html_url":"https://github.com/karmacoma","followers_url":"https://api.github.com/users/karmacoma/followers","following_url":"https://api.github.com/users/karmacoma/following{/other_user}","gists_url":"https://api.github.com/users/karmacoma/gists{/gist_id}","starred_url":"https://api.github.com/users/karmacoma/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/karmacoma/subscriptions","organizations_url":"https://api.github.com/users/karmacoma/orgs","repos_url":"https://api.github.com/users/karmacoma/repos","events_url":"https://api.github.com/users/karmacoma/events{/privacy}","received_events_url":"https://api.github.com/users/karmacoma/received_events","type":"User","site_admin":false},{"login":"Tschakki","id":1993505,"avatar_url":"https://avatars2.githubusercontent.com/u/1993505?v=4","gravatar_id":"","url":"https://api.github.com/users/Tschakki","html_url":"https://github.com/Tschakki","followers_url":"https://api.github.com/users/Tschakki/followers","following_url":"https://api.github.com/users/Tschakki/following{/other_user}","gists_url":"https://api.github.com/users/Tschakki/gists{/gist_id}","starred_url":"https://api.github.com/users/Tschakki/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Tschakki/subscriptions","organizations_url":"https://api.github.com/users/Tschakki/orgs","repos_url":"https://api.github.com/users/Tschakki/repos","events_url":"https://api.github.com/users/Tschakki/events{/privacy}","received_events_url":"https://api.github.com/users/Tschakki/received_events","type":"User","site_admin":false}],"requested_reviewers":[],"requested_teams":[],"labels":[{"id":655482394,"url":"https://api.github.com/repos/LiskHQ/lisk/labels/pending%20review","name":"pending review","color":"ededed","default":false}],"milestone":null,"commits_url":"https://api.github.com/repos/LiskHQ/lisk/pulls/1532/commits","review_comments_url":"https://api.github.com/repos/LiskHQ/lisk/pulls/1532/comments","review_comment_url":"https://api.github.com/repos/LiskHQ/lisk/pulls/comments{/number}","comments_url":"https://api.github.com/repos/LiskHQ/lisk/issues/1532/comments","statuses_url":"https://api.github.com/repos/LiskHQ/lisk/statuses/aac4d88d8ab4b82e19aba5171fa367cab44e1e1f","head":{"label":"LiskHQ:1481-standardize_code_documentation_in_helpers","ref":"1481-standardize_code_documentation_in_helpers","sha":"aac4d88d8ab4b82e19aba5171fa367cab44e1e1f","user":{"login":"LiskHQ","id":16600915,"avatar_url":"https://avatars1.githubusercontent.com/u/16600915?v=4","gravatar_id":"","url":"https://api.github.com/users/LiskHQ","html_url":"https://github.com/LiskHQ","followers_url":"https://api.github.com/users/LiskHQ/followers","following_url":"https://api.github.com/users/LiskHQ/following{/other_user}","gists_url":"https://api.github.com/users/LiskHQ/gists{/gist_id}","starred_url":"https://api.github.com/users/LiskHQ/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/LiskHQ/subscriptions","organizations_url":"https://api.github.com/users/LiskHQ/orgs","repos_url":"https://api.github.com/users/LiskHQ/repos","events_url":"https://api.github.com/users/LiskHQ/events{/privacy}","received_events_url":"https://api.github.com/users/LiskHQ/received_events","type":"Organization","site_admin":false},"repo":{"id":50873641,"name":"lisk","full_name":"LiskHQ/lisk","owner":{"login":"LiskHQ","id":16600915,"avatar_url":"https://avatars1.githubusercontent.com/u/16600915?v=4","gravatar_id":"","url":"https://api.github.com/users/LiskHQ","html_url":"https://github.com/LiskHQ","followers_url":"https://api.github.com/users/LiskHQ/followers","following_url":"https://api.github.com/users/LiskHQ/following{/other_user}","gists_url":"https://api.github.com/users/LiskHQ/gists{/gist_id}","starred_url":"https://api.github.com/users/LiskHQ/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/LiskHQ/subscriptions","organizations_url":"https://api.github.com/users/LiskHQ/orgs","repos_url":"https://api.github.com/users/LiskHQ/repos","events_url":"https://api.github.com/users/LiskHQ/events{/privacy}","received_events_url":"https://api.github.com/users/LiskHQ/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/LiskHQ/lisk","description":"📟 Lisk blockchain application platform","fork":false,"url":"https://api.github.com/repos/LiskHQ/lisk","forks_url":"https://api.github.com/repos/LiskHQ/lisk/forks","keys_url":"https://api.github.com/repos/LiskHQ/lisk/keys{/key_id}","collaborators_url":"https://api.github.com/repos/LiskHQ/lisk/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/LiskHQ/lisk/teams","hooks_url":"https://api.github.com/repos/LiskHQ/lisk/hooks","issue_events_url":"https://api.github.com/repos/LiskHQ/lisk/issues/events{/number}","events_url":"https://api.github.com/repos/LiskHQ/lisk/events","assignees_url":"https://api.github.com/repos/LiskHQ/lisk/assignees{/user}","branches_url":"https://api.github.com/repos/LiskHQ/lisk/branches{/branch}","tags_url":"https://api.github.com/repos/LiskHQ/lisk/tags","blobs_url":"https://api.github.com/repos/LiskHQ/lisk/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/LiskHQ/lisk/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/LiskHQ/lisk/git/refs{/sha}","trees_url":"https://api.github.com/repos/LiskHQ/lisk/git/trees{/sha}","statuses_url":"https://api.github.com/repos/LiskHQ/lisk/statuses/{sha}","languages_url":"https://api.github.com/repos/LiskHQ/lisk/languages","stargazers_url":"https://api.github.com/repos/LiskHQ/lisk/stargazers","contributors_url":"https://api.github.com/repos/LiskHQ/lisk/contributors","subscribers_url":"https://api.github.com/repos/LiskHQ/lisk/subscribers","subscription_url":"https://api.github.com/repos/LiskHQ/lisk/subscription","commits_url":"https://api.github.com/repos/LiskHQ/lisk/commits{/sha}","git_commits_url":"https://api.github.com/repos/LiskHQ/lisk/git/commits{/sha}","comments_url":"https://api.github.com/repos/LiskHQ/lisk/comments{/number}","issue_comment_url":"https://api.github.com/repos/LiskHQ/lisk/issues/comments{/number}","contents_url":"https://api.github.com/repos/LiskHQ/lisk/contents/{+path}","compare_url":"https://api.github.com/repos/LiskHQ/lisk/compare/{base}...{head}","merges_url":"https://api.github.com/repos/LiskHQ/lisk/merges","archive_url":"https://api.github.com/repos/LiskHQ/lisk/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/LiskHQ/lisk/downloads","issues_url":"https://api.github.com/repos/LiskHQ/lisk/issues{/number}","pulls_url":"https://api.github.com/repos/LiskHQ/lisk/pulls{/number}","milestones_url":"https://api.github.com/repos/LiskHQ/lisk/milestones{/number}","notifications_url":"https://api.github.com/repos/LiskHQ/lisk/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/LiskHQ/lisk/labels{/name}","releases_url":"https://api.github.com/repos/LiskHQ/lisk/releases{/id}","deployments_url":"https://api.github.com/repos/LiskHQ/lisk/deployments","created_at":"2016-02-01T21:45:35Z","updated_at":"2018-02-13T11:32:47Z","pushed_at":"2018-02-13T11:39:02Z","git_url":"git://github.com/LiskHQ/lisk.git","ssh_url":"git@github.com:LiskHQ/lisk.git","clone_url":"https://github.com/LiskHQ/lisk.git","svn_url":"https://github.com/LiskHQ/lisk","homepage":"https://lisk.io/","size":14912,"stargazers_count":1917,"watchers_count":1917,"language":"JavaScript","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":272,"mirror_url":null,"archived":false,"open_issues_count":94,"license":{"key":"gpl-3.0","name":"GNU General Public License v3.0","spdx_id":"GPL-3.0","url":"https://api.github.com/licenses/gpl-3.0"},"forks":272,"open_issues":94,"watchers":1917,"default_branch":"development"}},"base":{"label":"LiskHQ:1.0.0","ref":"1.0.0","sha":"54c83f47aa096429d61605b4812c1325ea0768d3","user":{"login":"LiskHQ","id":16600915,"avatar_url":"https://avatars1.githubusercontent.com/u/16600915?v=4","gravatar_id":"","url":"https://api.github.com/users/LiskHQ","html_url":"https://github.com/LiskHQ","followers_url":"https://api.github.com/users/LiskHQ/followers","following_url":"https://api.github.com/users/LiskHQ/following{/other_user}","gists_url":"https://api.github.com/users/LiskHQ/gists{/gist_id}","starred_url":"https://api.github.com/users/LiskHQ/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/LiskHQ/subscriptions","organizations_url":"https://api.github.com/users/LiskHQ/orgs","repos_url":"https://api.github.com/users/LiskHQ/repos","events_url":"https://api.github.com/users/LiskHQ/events{/privacy}","received_events_url":"https://api.github.com/users/LiskHQ/received_events","type":"Organization","site_admin":false},"repo":{"id":50873641,"name":"lisk","full_name":"LiskHQ/lisk","owner":{"login":"LiskHQ","id":16600915,"avatar_url":"https://avatars1.githubusercontent.com/u/16600915?v=4","gravatar_id":"","url":"https://api.github.com/users/LiskHQ","html_url":"https://github.com/LiskHQ","followers_url":"https://api.github.com/users/LiskHQ/followers","following_url":"https://api.github.com/users/LiskHQ/following{/other_user}","gists_url":"https://api.github.com/users/LiskHQ/gists{/gist_id}","starred_url":"https://api.github.com/users/LiskHQ/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/LiskHQ/subscriptions","organizations_url":"https://api.github.com/users/LiskHQ/orgs","repos_url":"https://api.github.com/users/LiskHQ/repos","events_url":"https://api.github.com/users/LiskHQ/events{/privacy}","received_events_url":"https://api.github.com/users/LiskHQ/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/LiskHQ/lisk","description":"📟 Lisk blockchain application platform","fork":false,"url":"https://api.github.com/repos/LiskHQ/lisk","forks_url":"https://api.github.com/repos/LiskHQ/lisk/forks","keys_url":"https://api.github.com/repos/LiskHQ/lisk/keys{/key_id}","collaborators_url":"https://api.github.com/repos/LiskHQ/lisk/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/LiskHQ/lisk/teams","hooks_url":"https://api.github.com/repos/LiskHQ/lisk/hooks","issue_events_url":"https://api.github.com/repos/LiskHQ/lisk/issues/events{/number}","events_url":"https://api.github.com/repos/LiskHQ/lisk/events","assignees_url":"https://api.github.com/repos/LiskHQ/lisk/assignees{/user}","branches_url":"https://api.github.com/repos/LiskHQ/lisk/branches{/branch}","tags_url":"https://api.github.com/repos/LiskHQ/lisk/tags","blobs_url":"https://api.github.com/repos/LiskHQ/lisk/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/LiskHQ/lisk/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/LiskHQ/lisk/git/refs{/sha}","trees_url":"https://api.github.com/repos/LiskHQ/lisk/git/trees{/sha}","statuses_url":"https://api.github.com/repos/LiskHQ/lisk/statuses/{sha}","languages_url":"https://api.github.com/repos/LiskHQ/lisk/languages","stargazers_url":"https://api.github.com/repos/LiskHQ/lisk/stargazers","contributors_url":"https://api.github.com/repos/LiskHQ/lisk/contributors","subscribers_url":"https://api.github.com/repos/LiskHQ/lisk/subscribers","subscription_url":"https://api.github.com/repos/LiskHQ/lisk/subscription","commits_url":"https://api.github.com/repos/LiskHQ/lisk/commits{/sha}","git_commits_url":"https://api.github.com/repos/LiskHQ/lisk/git/commits{/sha}","comments_url":"https://api.github.com/repos/LiskHQ/lisk/comments{/number}","issue_comment_url":"https://api.github.com/repos/LiskHQ/lisk/issues/comments{/number}","contents_url":"https://api.github.com/repos/LiskHQ/lisk/contents/{+path}","compare_url":"https://api.github.com/repos/LiskHQ/lisk/compare/{base}...{head}","merges_url":"https://api.github.com/repos/LiskHQ/lisk/merges","archive_url":"https://api.github.com/repos/LiskHQ/lisk/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/LiskHQ/lisk/downloads","issues_url":"https://api.github.com/repos/LiskHQ/lisk/issues{/number}","pulls_url":"https://api.github.com/repos/LiskHQ/lisk/pulls{/number}","milestones_url":"https://api.github.com/repos/LiskHQ/lisk/milestones{/number}","notifications_url":"https://api.github.com/repos/LiskHQ/lisk/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/LiskHQ/lisk/labels{/name}","releases_url":"https://api.github.com/repos/LiskHQ/lisk/releases{/id}","deployments_url":"https://api.github.com/repos/LiskHQ/lisk/deployments","created_at":"2016-02-01T21:45:35Z","updated_at":"2018-02-13T11:32:47Z","pushed_at":"2018-02-13T11:39:02Z","git_url":"git://github.com/LiskHQ/lisk.git","ssh_url":"git@github.com:LiskHQ/lisk.git","clone_url":"https://github.com/LiskHQ/lisk.git","svn_url":"https://github.com/LiskHQ/lisk","homepage":"https://lisk.io/","size":14912,"stargazers_count":1917,"watchers_count":1917,"language":"JavaScript","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":272,"mirror_url":null,"archived":false,"open_issues_count":94,"license":{"key":"gpl-3.0","name":"GNU General Public License v3.0","spdx_id":"GPL-3.0","url":"https://api.github.com/licenses/gpl-3.0"},"forks":272,"open_issues":94,"watchers":1917,"default_branch":"development"}},"_links":{"self":{"href":"https://api.github.com/repos/LiskHQ/lisk/pulls/1532"},"html":{"href":"https://github.com/LiskHQ/lisk/pull/1532"},"issue":{"href":"https://api.github.com/repos/LiskHQ/lisk/issues/1532"},"comments":{"href":"https://api.github.com/repos/LiskHQ/lisk/issues/1532/comments"},"review_comments":{"href":"https://api.github.com/repos/LiskHQ/lisk/pulls/1532/comments"},"review_comment":{"href":"https://api.github.com/repos/LiskHQ/lisk/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/LiskHQ/lisk/pulls/1532/commits"},"statuses":{"href":"https://api.github.com/repos/LiskHQ/lisk/statuses/aac4d88d8ab4b82e19aba5171fa367cab44e1e1f"}},"author_association":"MEMBER"}}
{"actor":{"display_login":"Tschakki"}}