{"action":"created","comment":{"url":"https://api.github.com/repos/acquaman/acquaman/pulls/comments/30704604","id":30704604,"diff_hunk":"@@ -82,46 +135,129 @@ protected slots:\n \t// Slots that handle the state transitions of the scan controller.\n \t////////////////////////////////////////////////////////////////////////\n \n-\t/// Starts the scan controller if it was able to successfully initialize.\n+\t/*!\n+\t  * Handles the controller signalling that it has initialized. Attempts to\n+\t  * transition the controller to the running state.\n+\t  */\n \tvoid onControllerInitialized();\n-\t/// Saves the scan to the database if the controller was able to successfully start.\n+\n+\t/*!\n+\t  * Handles the controller signalling that it has successfully started. Saves\n+\t  * the scan to the database.\n+\t  */\n \tvoid onControllerStarted();\n-\t/// Handles at the action level if the controller is cancelled.\n+\n+\t/*!\n+\t  * Handles the controller signalling that the scan has been cancelled. If the\n+\t  * scan is known to the database, then an attempt to resave it is made. Adapts\n+\t  * the cancelled instruction to the Action3 interface.\n+\t  */\n \tvoid onControllerCancelled();\n-\t/// Handles at the action level if the controller fails.\n+\n+\t/*!\n+\t  * Handles the controller signalling that the scan has failed. If the scan\n+\t  * is known to the database, then an attempt to resave it is made. Adapts the\n+\t  * failed instruction to the Action3 interface.\n+\t  */\n \tvoid onControllerFailed();\n-\t/// Handles all the wrap up and clean up if the controller succeeds.\n+\n+\t/*!\n+\t  * Handles the controller signalling that the scan has succeeded. Saves the\n+\t  * finshed scan to the database and, if the configuration specifies an auto-export,\n+\t  * then an export is performed. Adapts the succeeded instruction to the Aciton3\n+\t  * interface.\n+\t  */\n \tvoid onControllerSucceeded();\n-\t/// Handles setting the status text when the initialization actions are started.\n+\n+\t/*!\n+\t  * Handles the controller signalling that it has begun the initialization\n+\t  * steps. Sets the status text for the action to \"Initializing\".\n+\t  */\n \tvoid onControllerInitializing();\n-\t/// Handles setting the status text when cleaning actions are started.\n+\n+\t/*!\n+\t  * Handles the controller signalling that it has begun the clean-up steps.\n+\t  * Sets the status text for the aciton to \"Cleaning up\".\n+\t  */\n \tvoid onControllerCleaningUp();\n-\t/// Handles the progress changed passed up from the controller.\n+\n+\t/*!\n+\t  * Handles the controller signaling a periodic status changed update. Re-emits\n+\t  * the progress changed signal on the Action3 interface.\n+\t  */\n \tvoid onControllerProgressChanged(double elapsed, double total);\n-\t/// Helper slot that updates the status text when the controller changes state.\n+\n+\t/*!\n+\t  * Handles the controller signaling that it has made a state transition.\n+\t  * Updates the status text to reflect the new state.\n+\t  *\n+\t  * /// Is this still the case. There's nothing in the body of this method ///\n+\t  */\n \tvoid onControllerStateChanged();\n \n-\t/// Handles making sure that we're ready for deletion\n+\t/*!\n+\t  * Prepares the scan action for deletion. The scan action will be added to\n+\t  * the deletion queue when the logging for this scan has been completed.\n+\t  * // I'm going off the body here. The name seems to suggest some other logic///\n+\t  */","path":"source/actions3/actions/AMScanAction.h","position":186,"original_position":186,"commit_id":"9f32303ef0a9df75b7920b9f398a7d0853d3a600","original_commit_id":"9f32303ef0a9df75b7920b9f398a7d0853d3a600","user":{"login":"iainworkman","id":7461599,"avatar_url":"https://avatars.githubusercontent.com/u/7461599?v=3","gravatar_id":"","url":"https://api.github.com/users/iainworkman","html_url":"https://github.com/iainworkman","followers_url":"https://api.github.com/users/iainworkman/followers","following_url":"https://api.github.com/users/iainworkman/following{/other_user}","gists_url":"https://api.github.com/users/iainworkman/gists{/gist_id}","starred_url":"https://api.github.com/users/iainworkman/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/iainworkman/subscriptions","organizations_url":"https://api.github.com/users/iainworkman/orgs","repos_url":"https://api.github.com/users/iainworkman/repos","events_url":"https://api.github.com/users/iainworkman/events{/privacy}","received_events_url":"https://api.github.com/users/iainworkman/received_events","type":"User","site_admin":false},"body":"I think this one is just a naming thing. checkReadyForDeletion() seems to suggest different behaviour than 'waiting till can be deleted, then delete' which the code seems to be doing. See [here](https://github.com/acquaman/acquaman/blob/master/source/actions3/actions/AMScanAction.cpp#L217-L224).","created_at":"2015-05-20T14:04:47Z","updated_at":"2015-05-20T14:04:47Z","html_url":"https://github.com/acquaman/acquaman/pull/1396#discussion_r30704604","pull_request_url":"https://api.github.com/repos/acquaman/acquaman/pulls/1396","_links":{"self":{"href":"https://api.github.com/repos/acquaman/acquaman/pulls/comments/30704604"},"html":{"href":"https://github.com/acquaman/acquaman/pull/1396#discussion_r30704604"},"pull_request":{"href":"https://api.github.com/repos/acquaman/acquaman/pulls/1396"}}},"pull_request":{"url":"https://api.github.com/repos/acquaman/acquaman/pulls/1396","id":35784013,"html_url":"https://github.com/acquaman/acquaman/pull/1396","diff_url":"https://github.com/acquaman/acquaman/pull/1396.diff","patch_url":"https://github.com/acquaman/acquaman/pull/1396.patch","issue_url":"https://api.github.com/repos/acquaman/acquaman/issues/1396","number":1396,"state":"open","locked":false,"title":"Pull Request for Issue1392: Expanding Scan System Documentation","user":{"login":"iainworkman","id":7461599,"avatar_url":"https://avatars.githubusercontent.com/u/7461599?v=3","gravatar_id":"","url":"https://api.github.com/users/iainworkman","html_url":"https://github.com/iainworkman","followers_url":"https://api.github.com/users/iainworkman/followers","following_url":"https://api.github.com/users/iainworkman/following{/other_user}","gists_url":"https://api.github.com/users/iainworkman/gists{/gist_id}","starred_url":"https://api.github.com/users/iainworkman/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/iainworkman/subscriptions","organizations_url":"https://api.github.com/users/iainworkman/orgs","repos_url":"https://api.github.com/users/iainworkman/repos","events_url":"https://api.github.com/users/iainworkman/events{/privacy}","received_events_url":"https://api.github.com/users/iainworkman/received_events","type":"User","site_admin":false},"body":"#1392 \r\n\r\nAdded/expanded upon documentation for the scan system classes.\r\nI added a few notes in the comments on stuff that didn't seem quite right. (I'll add line notes in the pr here for those as soon as possible).\r\nLet me know if I'm way off base with any of this.\r\n\r\n@dretrex I was wondering also if I should just add everyone to this, as its a discussion that I think pretty much everyone should be part of.","created_at":"2015-05-19T23:03:29Z","updated_at":"2015-05-20T14:04:47Z","closed_at":null,"merged_at":null,"merge_commit_sha":"0dc0096055e5fd29b749cbbd37910a318b1047b8","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/acquaman/acquaman/pulls/1396/commits","review_comments_url":"https://api.github.com/repos/acquaman/acquaman/pulls/1396/comments","review_comment_url":"https://api.github.com/repos/acquaman/acquaman/pulls/comments{/number}","comments_url":"https://api.github.com/repos/acquaman/acquaman/issues/1396/comments","statuses_url":"https://api.github.com/repos/acquaman/acquaman/statuses/9f32303ef0a9df75b7920b9f398a7d0853d3a600","head":{"label":"acquaman:Issue1392","ref":"Issue1392","sha":"9f32303ef0a9df75b7920b9f398a7d0853d3a600","user":{"login":"acquaman","id":602716,"avatar_url":"https://avatars.githubusercontent.com/u/602716?v=3","gravatar_id":"","url":"https://api.github.com/users/acquaman","html_url":"https://github.com/acquaman","followers_url":"https://api.github.com/users/acquaman/followers","following_url":"https://api.github.com/users/acquaman/following{/other_user}","gists_url":"https://api.github.com/users/acquaman/gists{/gist_id}","starred_url":"https://api.github.com/users/acquaman/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/acquaman/subscriptions","organizations_url":"https://api.github.com/users/acquaman/orgs","repos_url":"https://api.github.com/users/acquaman/repos","events_url":"https://api.github.com/users/acquaman/events{/privacy}","received_events_url":"https://api.github.com/users/acquaman/received_events","type":"Organization","site_admin":false},"repo":{"id":1333343,"name":"acquaman","full_name":"acquaman/acquaman","owner":{"login":"acquaman","id":602716,"avatar_url":"https://avatars.githubusercontent.com/u/602716?v=3","gravatar_id":"","url":"https://api.github.com/users/acquaman","html_url":"https://github.com/acquaman","followers_url":"https://api.github.com/users/acquaman/followers","following_url":"https://api.github.com/users/acquaman/following{/other_user}","gists_url":"https://api.github.com/users/acquaman/gists{/gist_id}","starred_url":"https://api.github.com/users/acquaman/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/acquaman/subscriptions","organizations_url":"https://api.github.com/users/acquaman/orgs","repos_url":"https://api.github.com/users/acquaman/repos","events_url":"https://api.github.com/users/acquaman/events{/privacy}","received_events_url":"https://api.github.com/users/acquaman/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/acquaman/acquaman","description":"Acquisition and Data Management for Big Science","fork":false,"url":"https://api.github.com/repos/acquaman/acquaman","forks_url":"https://api.github.com/repos/acquaman/acquaman/forks","keys_url":"https://api.github.com/repos/acquaman/acquaman/keys{/key_id}","collaborators_url":"https://api.github.com/repos/acquaman/acquaman/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/acquaman/acquaman/teams","hooks_url":"https://api.github.com/repos/acquaman/acquaman/hooks","issue_events_url":"https://api.github.com/repos/acquaman/acquaman/issues/events{/number}","events_url":"https://api.github.com/repos/acquaman/acquaman/events","assignees_url":"https://api.github.com/repos/acquaman/acquaman/assignees{/user}","branches_url":"https://api.github.com/repos/acquaman/acquaman/branches{/branch}","tags_url":"https://api.github.com/repos/acquaman/acquaman/tags","blobs_url":"https://api.github.com/repos/acquaman/acquaman/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/acquaman/acquaman/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/acquaman/acquaman/git/refs{/sha}","trees_url":"https://api.github.com/repos/acquaman/acquaman/git/trees{/sha}","statuses_url":"https://api.github.com/repos/acquaman/acquaman/statuses/{sha}","languages_url":"https://api.github.com/repos/acquaman/acquaman/languages","stargazers_url":"https://api.github.com/repos/acquaman/acquaman/stargazers","contributors_url":"https://api.github.com/repos/acquaman/acquaman/contributors","subscribers_url":"https://api.github.com/repos/acquaman/acquaman/subscribers","subscription_url":"https://api.github.com/repos/acquaman/acquaman/subscription","commits_url":"https://api.github.com/repos/acquaman/acquaman/commits{/sha}","git_commits_url":"https://api.github.com/repos/acquaman/acquaman/git/commits{/sha}","comments_url":"https://api.github.com/repos/acquaman/acquaman/comments{/number}","issue_comment_url":"https://api.github.com/repos/acquaman/acquaman/issues/comments{/number}","contents_url":"https://api.github.com/repos/acquaman/acquaman/contents/{+path}","compare_url":"https://api.github.com/repos/acquaman/acquaman/compare/{base}...{head}","merges_url":"https://api.github.com/repos/acquaman/acquaman/merges","archive_url":"https://api.github.com/repos/acquaman/acquaman/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/acquaman/acquaman/downloads","issues_url":"https://api.github.com/repos/acquaman/acquaman/issues{/number}","pulls_url":"https://api.github.com/repos/acquaman/acquaman/pulls{/number}","milestones_url":"https://api.github.com/repos/acquaman/acquaman/milestones{/number}","notifications_url":"https://api.github.com/repos/acquaman/acquaman/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/acquaman/acquaman/labels{/name}","releases_url":"https://api.github.com/repos/acquaman/acquaman/releases{/id}","created_at":"2011-02-06T02:19:01Z","updated_at":"2015-05-08T18:04:51Z","pushed_at":"2015-05-20T03:47:31Z","git_url":"git://github.com/acquaman/acquaman.git","ssh_url":"git@github.com:acquaman/acquaman.git","clone_url":"https://github.com/acquaman/acquaman.git","svn_url":"https://github.com/acquaman/acquaman","homepage":"","size":145585,"stargazers_count":8,"watchers_count":8,"language":"C++","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":2,"mirror_url":null,"open_issues_count":149,"forks":2,"open_issues":149,"watchers":8,"default_branch":"master"}},"base":{"label":"acquaman:master","ref":"master","sha":"f6e65bf4b26f386e5789f38d9b9f215a2bacb8db","user":{"login":"acquaman","id":602716,"avatar_url":"https://avatars.githubusercontent.com/u/602716?v=3","gravatar_id":"","url":"https://api.github.com/users/acquaman","html_url":"https://github.com/acquaman","followers_url":"https://api.github.com/users/acquaman/followers","following_url":"https://api.github.com/users/acquaman/following{/other_user}","gists_url":"https://api.github.com/users/acquaman/gists{/gist_id}","starred_url":"https://api.github.com/users/acquaman/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/acquaman/subscriptions","organizations_url":"https://api.github.com/users/acquaman/orgs","repos_url":"https://api.github.com/users/acquaman/repos","events_url":"https://api.github.com/users/acquaman/events{/privacy}","received_events_url":"https://api.github.com/users/acquaman/received_events","type":"Organization","site_admin":false},"repo":{"id":1333343,"name":"acquaman","full_name":"acquaman/acquaman","owner":{"login":"acquaman","id":602716,"avatar_url":"https://avatars.githubusercontent.com/u/602716?v=3","gravatar_id":"","url":"https://api.github.com/users/acquaman","html_url":"https://github.com/acquaman","followers_url":"https://api.github.com/users/acquaman/followers","following_url":"https://api.github.com/users/acquaman/following{/other_user}","gists_url":"https://api.github.com/users/acquaman/gists{/gist_id}","starred_url":"https://api.github.com/users/acquaman/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/acquaman/subscriptions","organizations_url":"https://api.github.com/users/acquaman/orgs","repos_url":"https://api.github.com/users/acquaman/repos","events_url":"https://api.github.com/users/acquaman/events{/privacy}","received_events_url":"https://api.github.com/users/acquaman/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/acquaman/acquaman","description":"Acquisition and Data Management for Big Science","fork":false,"url":"https://api.github.com/repos/acquaman/acquaman","forks_url":"https://api.github.com/repos/acquaman/acquaman/forks","keys_url":"https://api.github.com/repos/acquaman/acquaman/keys{/key_id}","collaborators_url":"https://api.github.com/repos/acquaman/acquaman/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/acquaman/acquaman/teams","hooks_url":"https://api.github.com/repos/acquaman/acquaman/hooks","issue_events_url":"https://api.github.com/repos/acquaman/acquaman/issues/events{/number}","events_url":"https://api.github.com/repos/acquaman/acquaman/events","assignees_url":"https://api.github.com/repos/acquaman/acquaman/assignees{/user}","branches_url":"https://api.github.com/repos/acquaman/acquaman/branches{/branch}","tags_url":"https://api.github.com/repos/acquaman/acquaman/tags","blobs_url":"https://api.github.com/repos/acquaman/acquaman/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/acquaman/acquaman/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/acquaman/acquaman/git/refs{/sha}","trees_url":"https://api.github.com/repos/acquaman/acquaman/git/trees{/sha}","statuses_url":"https://api.github.com/repos/acquaman/acquaman/statuses/{sha}","languages_url":"https://api.github.com/repos/acquaman/acquaman/languages","stargazers_url":"https://api.github.com/repos/acquaman/acquaman/stargazers","contributors_url":"https://api.github.com/repos/acquaman/acquaman/contributors","subscribers_url":"https://api.github.com/repos/acquaman/acquaman/subscribers","subscription_url":"https://api.github.com/repos/acquaman/acquaman/subscription","commits_url":"https://api.github.com/repos/acquaman/acquaman/commits{/sha}","git_commits_url":"https://api.github.com/repos/acquaman/acquaman/git/commits{/sha}","comments_url":"https://api.github.com/repos/acquaman/acquaman/comments{/number}","issue_comment_url":"https://api.github.com/repos/acquaman/acquaman/issues/comments{/number}","contents_url":"https://api.github.com/repos/acquaman/acquaman/contents/{+path}","compare_url":"https://api.github.com/repos/acquaman/acquaman/compare/{base}...{head}","merges_url":"https://api.github.com/repos/acquaman/acquaman/merges","archive_url":"https://api.github.com/repos/acquaman/acquaman/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/acquaman/acquaman/downloads","issues_url":"https://api.github.com/repos/acquaman/acquaman/issues{/number}","pulls_url":"https://api.github.com/repos/acquaman/acquaman/pulls{/number}","milestones_url":"https://api.github.com/repos/acquaman/acquaman/milestones{/number}","notifications_url":"https://api.github.com/repos/acquaman/acquaman/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/acquaman/acquaman/labels{/name}","releases_url":"https://api.github.com/repos/acquaman/acquaman/releases{/id}","created_at":"2011-02-06T02:19:01Z","updated_at":"2015-05-08T18:04:51Z","pushed_at":"2015-05-20T03:47:31Z","git_url":"git://github.com/acquaman/acquaman.git","ssh_url":"git@github.com:acquaman/acquaman.git","clone_url":"https://github.com/acquaman/acquaman.git","svn_url":"https://github.com/acquaman/acquaman","homepage":"","size":145585,"stargazers_count":8,"watchers_count":8,"language":"C++","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":2,"mirror_url":null,"open_issues_count":149,"forks":2,"open_issues":149,"watchers":8,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/acquaman/acquaman/pulls/1396"},"html":{"href":"https://github.com/acquaman/acquaman/pull/1396"},"issue":{"href":"https://api.github.com/repos/acquaman/acquaman/issues/1396"},"comments":{"href":"https://api.github.com/repos/acquaman/acquaman/issues/1396/comments"},"review_comments":{"href":"https://api.github.com/repos/acquaman/acquaman/pulls/1396/comments"},"review_comment":{"href":"https://api.github.com/repos/acquaman/acquaman/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/acquaman/acquaman/pulls/1396/commits"},"statuses":{"href":"https://api.github.com/repos/acquaman/acquaman/statuses/9f32303ef0a9df75b7920b9f398a7d0853d3a600"}}}}