{"action":"created","comment":{"url":"https://api.github.com/repos/Caltech-IPAC/firefly/pulls/comments/74631821","id":74631821,"diff_hunk":"@@ -0,0 +1,278 @@\n+<!DOCTYPE html>","path":"jsdoc/api_ApiBuild.js.html","position":1,"original_position":1,"commit_id":"2edb4558a9fb7578ee73dddcc02eb927dd9dc1cd","original_commit_id":"2edb4558a9fb7578ee73dddcc02eb927dd9dc1cd","user":{"login":"ejoliet","id":770124,"avatar_url":"https://avatars.githubusercontent.com/u/770124?v=3","gravatar_id":"","url":"https://api.github.com/users/ejoliet","html_url":"https://github.com/ejoliet","followers_url":"https://api.github.com/users/ejoliet/followers","following_url":"https://api.github.com/users/ejoliet/following{/other_user}","gists_url":"https://api.github.com/users/ejoliet/gists{/gist_id}","starred_url":"https://api.github.com/users/ejoliet/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ejoliet/subscriptions","organizations_url":"https://api.github.com/users/ejoliet/orgs","repos_url":"https://api.github.com/users/ejoliet/repos","events_url":"https://api.github.com/users/ejoliet/events{/privacy}","received_events_url":"https://api.github.com/users/ejoliet/received_events","type":"User","site_admin":false},"body":"this is a result from generating jsdoc, no need to be in git, only for version tagged or ops in general. jsdocs reflect stable ops version not ongoing unstable 'dev'.","created_at":"2016-08-12T17:48:37Z","updated_at":"2016-08-12T17:48:37Z","html_url":"https://github.com/Caltech-IPAC/firefly/pull/142#discussion_r74631821","pull_request_url":"https://api.github.com/repos/Caltech-IPAC/firefly/pulls/142","_links":{"self":{"href":"https://api.github.com/repos/Caltech-IPAC/firefly/pulls/comments/74631821"},"html":{"href":"https://github.com/Caltech-IPAC/firefly/pull/142#discussion_r74631821"},"pull_request":{"href":"https://api.github.com/repos/Caltech-IPAC/firefly/pulls/142"}}},"pull_request":{"url":"https://api.github.com/repos/Caltech-IPAC/firefly/pulls/142","id":81034069,"html_url":"https://github.com/Caltech-IPAC/firefly/pull/142","diff_url":"https://github.com/Caltech-IPAC/firefly/pull/142.diff","patch_url":"https://github.com/Caltech-IPAC/firefly/pull/142.patch","issue_url":"https://api.github.com/repos/Caltech-IPAC/firefly/issues/142","number":142,"state":"open","locked":false,"title":"DM-7038-JSDoc","user":{"login":"lznakano","id":11981693,"avatar_url":"https://avatars.githubusercontent.com/u/11981693?v=3","gravatar_id":"","url":"https://api.github.com/users/lznakano","html_url":"https://github.com/lznakano","followers_url":"https://api.github.com/users/lznakano/followers","following_url":"https://api.github.com/users/lznakano/following{/other_user}","gists_url":"https://api.github.com/users/lznakano/gists{/gist_id}","starred_url":"https://api.github.com/users/lznakano/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/lznakano/subscriptions","organizations_url":"https://api.github.com/users/lznakano/orgs","repos_url":"https://api.github.com/users/lznakano/repos","events_url":"https://api.github.com/users/lznakano/events{/privacy}","received_events_url":"https://api.github.com/users/lznakano/received_events","type":"User","site_admin":false},"body":"To look at the doc, please open jsdoc/index.html file.  I have edited the source files (.js and .jsx) to add document tags, add parameter' types and names etc to the best of my knowledge.  Please examine the them and let me know  of any of them are wrong.  I am sure some of them are not right. \r\n\r\nNOTE: \r\nModule:  it is for documentation purpose only, lowLevelApi and highLevelApi are just for listing the method/function etc in two category.  \r\n\r\nKnown issue:\r\n1.  The sorting in the template uses longname (path+methodName).  \r\n2.  The README.md file can be accepted by jsdoc, however, it does not translate the links inside    README.md file correctly.  Thus, I used a fireflyOverView.md instead.  There is an option to copy the static files but apparently, it does not work as it was described. \r\n3. I put the example markdown file into tutorial directory\r\n\r\nPlease read it through and let me know your comments and suggestions.  \r\n\r\nThanks!\r\n\r\nLZ\r\n\r\n\r\n","created_at":"2016-08-11T21:27:00Z","updated_at":"2016-08-12T17:48:37Z","closed_at":null,"merged_at":null,"merge_commit_sha":"2b01f258648ef1f9c994610f994cdb28732ef861","assignee":null,"assignees":[],"milestone":null,"commits_url":"https://api.github.com/repos/Caltech-IPAC/firefly/pulls/142/commits","review_comments_url":"https://api.github.com/repos/Caltech-IPAC/firefly/pulls/142/comments","review_comment_url":"https://api.github.com/repos/Caltech-IPAC/firefly/pulls/comments{/number}","comments_url":"https://api.github.com/repos/Caltech-IPAC/firefly/issues/142/comments","statuses_url":"https://api.github.com/repos/Caltech-IPAC/firefly/statuses/2edb4558a9fb7578ee73dddcc02eb927dd9dc1cd","head":{"label":"Caltech-IPAC:DM-7038-JSDoc","ref":"DM-7038-JSDoc","sha":"2edb4558a9fb7578ee73dddcc02eb927dd9dc1cd","user":{"login":"Caltech-IPAC","id":9708378,"avatar_url":"https://avatars.githubusercontent.com/u/9708378?v=3","gravatar_id":"","url":"https://api.github.com/users/Caltech-IPAC","html_url":"https://github.com/Caltech-IPAC","followers_url":"https://api.github.com/users/Caltech-IPAC/followers","following_url":"https://api.github.com/users/Caltech-IPAC/following{/other_user}","gists_url":"https://api.github.com/users/Caltech-IPAC/gists{/gist_id}","starred_url":"https://api.github.com/users/Caltech-IPAC/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Caltech-IPAC/subscriptions","organizations_url":"https://api.github.com/users/Caltech-IPAC/orgs","repos_url":"https://api.github.com/users/Caltech-IPAC/repos","events_url":"https://api.github.com/users/Caltech-IPAC/events{/privacy}","received_events_url":"https://api.github.com/users/Caltech-IPAC/received_events","type":"Organization","site_admin":false},"repo":{"id":33508214,"name":"firefly","full_name":"Caltech-IPAC/firefly","owner":{"login":"Caltech-IPAC","id":9708378,"avatar_url":"https://avatars.githubusercontent.com/u/9708378?v=3","gravatar_id":"","url":"https://api.github.com/users/Caltech-IPAC","html_url":"https://github.com/Caltech-IPAC","followers_url":"https://api.github.com/users/Caltech-IPAC/followers","following_url":"https://api.github.com/users/Caltech-IPAC/following{/other_user}","gists_url":"https://api.github.com/users/Caltech-IPAC/gists{/gist_id}","starred_url":"https://api.github.com/users/Caltech-IPAC/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Caltech-IPAC/subscriptions","organizations_url":"https://api.github.com/users/Caltech-IPAC/orgs","repos_url":"https://api.github.com/users/Caltech-IPAC/repos","events_url":"https://api.github.com/users/Caltech-IPAC/events{/privacy}","received_events_url":"https://api.github.com/users/Caltech-IPAC/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/Caltech-IPAC/firefly","description":"","fork":false,"url":"https://api.github.com/repos/Caltech-IPAC/firefly","forks_url":"https://api.github.com/repos/Caltech-IPAC/firefly/forks","keys_url":"https://api.github.com/repos/Caltech-IPAC/firefly/keys{/key_id}","collaborators_url":"https://api.github.com/repos/Caltech-IPAC/firefly/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/Caltech-IPAC/firefly/teams","hooks_url":"https://api.github.com/repos/Caltech-IPAC/firefly/hooks","issue_events_url":"https://api.github.com/repos/Caltech-IPAC/firefly/issues/events{/number}","events_url":"https://api.github.com/repos/Caltech-IPAC/firefly/events","assignees_url":"https://api.github.com/repos/Caltech-IPAC/firefly/assignees{/user}","branches_url":"https://api.github.com/repos/Caltech-IPAC/firefly/branches{/branch}","tags_url":"https://api.github.com/repos/Caltech-IPAC/firefly/tags","blobs_url":"https://api.github.com/repos/Caltech-IPAC/firefly/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/Caltech-IPAC/firefly/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/Caltech-IPAC/firefly/git/refs{/sha}","trees_url":"https://api.github.com/repos/Caltech-IPAC/firefly/git/trees{/sha}","statuses_url":"https://api.github.com/repos/Caltech-IPAC/firefly/statuses/{sha}","languages_url":"https://api.github.com/repos/Caltech-IPAC/firefly/languages","stargazers_url":"https://api.github.com/repos/Caltech-IPAC/firefly/stargazers","contributors_url":"https://api.github.com/repos/Caltech-IPAC/firefly/contributors","subscribers_url":"https://api.github.com/repos/Caltech-IPAC/firefly/subscribers","subscription_url":"https://api.github.com/repos/Caltech-IPAC/firefly/subscription","commits_url":"https://api.github.com/repos/Caltech-IPAC/firefly/commits{/sha}","git_commits_url":"https://api.github.com/repos/Caltech-IPAC/firefly/git/commits{/sha}","comments_url":"https://api.github.com/repos/Caltech-IPAC/firefly/comments{/number}","issue_comment_url":"https://api.github.com/repos/Caltech-IPAC/firefly/issues/comments{/number}","contents_url":"https://api.github.com/repos/Caltech-IPAC/firefly/contents/{+path}","compare_url":"https://api.github.com/repos/Caltech-IPAC/firefly/compare/{base}...{head}","merges_url":"https://api.github.com/repos/Caltech-IPAC/firefly/merges","archive_url":"https://api.github.com/repos/Caltech-IPAC/firefly/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/Caltech-IPAC/firefly/downloads","issues_url":"https://api.github.com/repos/Caltech-IPAC/firefly/issues{/number}","pulls_url":"https://api.github.com/repos/Caltech-IPAC/firefly/pulls{/number}","milestones_url":"https://api.github.com/repos/Caltech-IPAC/firefly/milestones{/number}","notifications_url":"https://api.github.com/repos/Caltech-IPAC/firefly/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/Caltech-IPAC/firefly/labels{/name}","releases_url":"https://api.github.com/repos/Caltech-IPAC/firefly/releases{/id}","deployments_url":"https://api.github.com/repos/Caltech-IPAC/firefly/deployments","created_at":"2015-04-06T22:03:13Z","updated_at":"2016-05-06T19:30:48Z","pushed_at":"2016-08-12T16:49:48Z","git_url":"git://github.com/Caltech-IPAC/firefly.git","ssh_url":"git@github.com:Caltech-IPAC/firefly.git","clone_url":"https://github.com/Caltech-IPAC/firefly.git","svn_url":"https://github.com/Caltech-IPAC/firefly","homepage":null,"size":170048,"stargazers_count":3,"watchers_count":3,"language":"Java","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":1,"mirror_url":null,"open_issues_count":5,"forks":1,"open_issues":5,"watchers":3,"default_branch":"dev"}},"base":{"label":"Caltech-IPAC:dev","ref":"dev","sha":"3cadbe8640a8acb8a26a757f422d09a234014669","user":{"login":"Caltech-IPAC","id":9708378,"avatar_url":"https://avatars.githubusercontent.com/u/9708378?v=3","gravatar_id":"","url":"https://api.github.com/users/Caltech-IPAC","html_url":"https://github.com/Caltech-IPAC","followers_url":"https://api.github.com/users/Caltech-IPAC/followers","following_url":"https://api.github.com/users/Caltech-IPAC/following{/other_user}","gists_url":"https://api.github.com/users/Caltech-IPAC/gists{/gist_id}","starred_url":"https://api.github.com/users/Caltech-IPAC/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Caltech-IPAC/subscriptions","organizations_url":"https://api.github.com/users/Caltech-IPAC/orgs","repos_url":"https://api.github.com/users/Caltech-IPAC/repos","events_url":"https://api.github.com/users/Caltech-IPAC/events{/privacy}","received_events_url":"https://api.github.com/users/Caltech-IPAC/received_events","type":"Organization","site_admin":false},"repo":{"id":33508214,"name":"firefly","full_name":"Caltech-IPAC/firefly","owner":{"login":"Caltech-IPAC","id":9708378,"avatar_url":"https://avatars.githubusercontent.com/u/9708378?v=3","gravatar_id":"","url":"https://api.github.com/users/Caltech-IPAC","html_url":"https://github.com/Caltech-IPAC","followers_url":"https://api.github.com/users/Caltech-IPAC/followers","following_url":"https://api.github.com/users/Caltech-IPAC/following{/other_user}","gists_url":"https://api.github.com/users/Caltech-IPAC/gists{/gist_id}","starred_url":"https://api.github.com/users/Caltech-IPAC/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Caltech-IPAC/subscriptions","organizations_url":"https://api.github.com/users/Caltech-IPAC/orgs","repos_url":"https://api.github.com/users/Caltech-IPAC/repos","events_url":"https://api.github.com/users/Caltech-IPAC/events{/privacy}","received_events_url":"https://api.github.com/users/Caltech-IPAC/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/Caltech-IPAC/firefly","description":"","fork":false,"url":"https://api.github.com/repos/Caltech-IPAC/firefly","forks_url":"https://api.github.com/repos/Caltech-IPAC/firefly/forks","keys_url":"https://api.github.com/repos/Caltech-IPAC/firefly/keys{/key_id}","collaborators_url":"https://api.github.com/repos/Caltech-IPAC/firefly/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/Caltech-IPAC/firefly/teams","hooks_url":"https://api.github.com/repos/Caltech-IPAC/firefly/hooks","issue_events_url":"https://api.github.com/repos/Caltech-IPAC/firefly/issues/events{/number}","events_url":"https://api.github.com/repos/Caltech-IPAC/firefly/events","assignees_url":"https://api.github.com/repos/Caltech-IPAC/firefly/assignees{/user}","branches_url":"https://api.github.com/repos/Caltech-IPAC/firefly/branches{/branch}","tags_url":"https://api.github.com/repos/Caltech-IPAC/firefly/tags","blobs_url":"https://api.github.com/repos/Caltech-IPAC/firefly/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/Caltech-IPAC/firefly/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/Caltech-IPAC/firefly/git/refs{/sha}","trees_url":"https://api.github.com/repos/Caltech-IPAC/firefly/git/trees{/sha}","statuses_url":"https://api.github.com/repos/Caltech-IPAC/firefly/statuses/{sha}","languages_url":"https://api.github.com/repos/Caltech-IPAC/firefly/languages","stargazers_url":"https://api.github.com/repos/Caltech-IPAC/firefly/stargazers","contributors_url":"https://api.github.com/repos/Caltech-IPAC/firefly/contributors","subscribers_url":"https://api.github.com/repos/Caltech-IPAC/firefly/subscribers","subscription_url":"https://api.github.com/repos/Caltech-IPAC/firefly/subscription","commits_url":"https://api.github.com/repos/Caltech-IPAC/firefly/commits{/sha}","git_commits_url":"https://api.github.com/repos/Caltech-IPAC/firefly/git/commits{/sha}","comments_url":"https://api.github.com/repos/Caltech-IPAC/firefly/comments{/number}","issue_comment_url":"https://api.github.com/repos/Caltech-IPAC/firefly/issues/comments{/number}","contents_url":"https://api.github.com/repos/Caltech-IPAC/firefly/contents/{+path}","compare_url":"https://api.github.com/repos/Caltech-IPAC/firefly/compare/{base}...{head}","merges_url":"https://api.github.com/repos/Caltech-IPAC/firefly/merges","archive_url":"https://api.github.com/repos/Caltech-IPAC/firefly/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/Caltech-IPAC/firefly/downloads","issues_url":"https://api.github.com/repos/Caltech-IPAC/firefly/issues{/number}","pulls_url":"https://api.github.com/repos/Caltech-IPAC/firefly/pulls{/number}","milestones_url":"https://api.github.com/repos/Caltech-IPAC/firefly/milestones{/number}","notifications_url":"https://api.github.com/repos/Caltech-IPAC/firefly/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/Caltech-IPAC/firefly/labels{/name}","releases_url":"https://api.github.com/repos/Caltech-IPAC/firefly/releases{/id}","deployments_url":"https://api.github.com/repos/Caltech-IPAC/firefly/deployments","created_at":"2015-04-06T22:03:13Z","updated_at":"2016-05-06T19:30:48Z","pushed_at":"2016-08-12T16:49:48Z","git_url":"git://github.com/Caltech-IPAC/firefly.git","ssh_url":"git@github.com:Caltech-IPAC/firefly.git","clone_url":"https://github.com/Caltech-IPAC/firefly.git","svn_url":"https://github.com/Caltech-IPAC/firefly","homepage":null,"size":170048,"stargazers_count":3,"watchers_count":3,"language":"Java","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":1,"mirror_url":null,"open_issues_count":5,"forks":1,"open_issues":5,"watchers":3,"default_branch":"dev"}},"_links":{"self":{"href":"https://api.github.com/repos/Caltech-IPAC/firefly/pulls/142"},"html":{"href":"https://github.com/Caltech-IPAC/firefly/pull/142"},"issue":{"href":"https://api.github.com/repos/Caltech-IPAC/firefly/issues/142"},"comments":{"href":"https://api.github.com/repos/Caltech-IPAC/firefly/issues/142/comments"},"review_comments":{"href":"https://api.github.com/repos/Caltech-IPAC/firefly/pulls/142/comments"},"review_comment":{"href":"https://api.github.com/repos/Caltech-IPAC/firefly/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/Caltech-IPAC/firefly/pulls/142/commits"},"statuses":{"href":"https://api.github.com/repos/Caltech-IPAC/firefly/statuses/2edb4558a9fb7578ee73dddcc02eb927dd9dc1cd"}}}}
{"actor":{"display_login":"ejoliet"}}