{"action":"created","comment":{"url":"https://api.github.com/repos/diffblue/cbmc/pulls/comments/233116067","pull_request_review_id":174442940,"id":233116067,"node_id":"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDIzMzExNjA2Nw==","diff_hunk":"@@ -87,78 +118,132 @@ class symex_targett\n     const sourcet &source,\n     assignment_typet assignment_type)=0;\n \n-  // declare fresh variable - lhs must be symbol\n+  /// Declaring a fresh variable.\n+  /// \\param guard: condition to declare this variable\n+  /// \\param ssa_lhs: variable to be declared, must be symbol\n+  /// \\param source: pointer to location in the input GOTO program of this\n+  /// declaration\n+  /// \\param assignment_type: to distinguish between different types of\n+  /// assignments (some may be hidden for the further analysis)\n   virtual void decl(\n     const exprt &guard,\n     const ssa_exprt &ssa_lhs,\n     const sourcet &source,\n     assignment_typet assignment_type)=0;\n \n-  // note the death of a variable - lhs must be symbol\n+  /// Remove a variable from the scope.\n+  /// \\param guard: condition to remove this variable\n+  /// \\param ssa_lhs: variable to be removed, must be symbol\n+  /// \\param source: pointer to location in the input GOTO program of this\n+  /// removal\n   virtual void dead(\n     const exprt &guard,\n     const ssa_exprt &ssa_lhs,\n     const sourcet &source)=0;\n \n-  // record a function call\n+  /// Record a function call.\n+  /// \\param guard: condition to call the function","path":"src/goto-symex/symex_target.h","position":101,"original_position":101,"commit_id":"c0b43dae325d222ccb1fb226979582b7a64d48b2","original_commit_id":"93ec733faa988633b55ae70144be8e663c3d4326","user":{"login":"svorenova","id":19727952,"node_id":"MDQ6VXNlcjE5NzI3OTUy","avatar_url":"https://avatars0.githubusercontent.com/u/19727952?v=4","gravatar_id":"","url":"https://api.github.com/users/svorenova","html_url":"https://github.com/svorenova","followers_url":"https://api.github.com/users/svorenova/followers","following_url":"https://api.github.com/users/svorenova/following{/other_user}","gists_url":"https://api.github.com/users/svorenova/gists{/gist_id}","starred_url":"https://api.github.com/users/svorenova/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/svorenova/subscriptions","organizations_url":"https://api.github.com/users/svorenova/orgs","repos_url":"https://api.github.com/users/svorenova/repos","events_url":"https://api.github.com/users/svorenova/events{/privacy}","received_events_url":"https://api.github.com/users/svorenova/received_events","type":"User","site_admin":false},"body":":strawberry: ","created_at":"2018-11-13T16:19:41Z","updated_at":"2018-11-13T16:40:53Z","html_url":"https://github.com/diffblue/cbmc/pull/3393#discussion_r233116067","pull_request_url":"https://api.github.com/repos/diffblue/cbmc/pulls/3393","author_association":"CONTRIBUTOR","_links":{"self":{"href":"https://api.github.com/repos/diffblue/cbmc/pulls/comments/233116067"},"html":{"href":"https://github.com/diffblue/cbmc/pull/3393#discussion_r233116067"},"pull_request":{"href":"https://api.github.com/repos/diffblue/cbmc/pulls/3393"}}},"pull_request":{"url":"https://api.github.com/repos/diffblue/cbmc/pulls/3393","id":230515610,"node_id":"MDExOlB1bGxSZXF1ZXN0MjMwNTE1NjEw","html_url":"https://github.com/diffblue/cbmc/pull/3393","diff_url":"https://github.com/diffblue/cbmc/pull/3393.diff","patch_url":"https://github.com/diffblue/cbmc/pull/3393.patch","issue_url":"https://api.github.com/repos/diffblue/cbmc/issues/3393","number":3393,"state":"open","locked":false,"title":"Class and function documentation for goto-symex-target [DOC-79]","user":{"login":"xbauch","id":8643050,"node_id":"MDQ6VXNlcjg2NDMwNTA=","avatar_url":"https://avatars1.githubusercontent.com/u/8643050?v=4","gravatar_id":"","url":"https://api.github.com/users/xbauch","html_url":"https://github.com/xbauch","followers_url":"https://api.github.com/users/xbauch/followers","following_url":"https://api.github.com/users/xbauch/following{/other_user}","gists_url":"https://api.github.com/users/xbauch/gists{/gist_id}","starred_url":"https://api.github.com/users/xbauch/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/xbauch/subscriptions","organizations_url":"https://api.github.com/users/xbauch/orgs","repos_url":"https://api.github.com/users/xbauch/repos","events_url":"https://api.github.com/users/xbauch/events{/privacy}","received_events_url":"https://api.github.com/users/xbauch/received_events","type":"User","site_admin":false},"body":"Adding class and function documentation to goto-symex/symex_target. {h,cpp} and goto-symex/symex_target_equation.{h,cpp}.\r\n\r\n- [x] Each commit message has a non-empty body, explaining why the change was made.\r\n- [x] Methods or procedures I have added are documented, following the guidelines provided in CODING_STANDARD.md.\r\n- [ ] Regression or unit tests are included, or existing tests cover the modified code (in this case I have detailed which ones those are in the commit message).\r\n- [ ] My commit message includes data points confirming performance improvements (if claimed).\r\n- [x] My PR is restricted to a single feature or bugfix.\r\n- [x] White-space or formatting changes outside the feature-related changed lines are in commits of their own.\r\n\r\n<!---\r\nSee, e.g., https://chris.beams.io/posts/git-commit/ for general guidelines on commit messages.\r\n\r\nIf you have created commits mixing multiple features and/or unrelated white-space changes, use a sequence involving git reset and git add -p to fix this.\r\n--->\r\n","created_at":"2018-11-13T15:25:54Z","updated_at":"2018-11-13T16:40:52Z","closed_at":null,"merged_at":null,"merge_commit_sha":"d7ee43cd28c86a26a2a8d4c5fc78d959f7676c09","assignee":null,"assignees":[],"requested_reviewers":[{"login":"tautschnig","id":1144736,"node_id":"MDQ6VXNlcjExNDQ3MzY=","avatar_url":"https://avatars3.githubusercontent.com/u/1144736?v=4","gravatar_id":"","url":"https://api.github.com/users/tautschnig","html_url":"https://github.com/tautschnig","followers_url":"https://api.github.com/users/tautschnig/followers","following_url":"https://api.github.com/users/tautschnig/following{/other_user}","gists_url":"https://api.github.com/users/tautschnig/gists{/gist_id}","starred_url":"https://api.github.com/users/tautschnig/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/tautschnig/subscriptions","organizations_url":"https://api.github.com/users/tautschnig/orgs","repos_url":"https://api.github.com/users/tautschnig/repos","events_url":"https://api.github.com/users/tautschnig/events{/privacy}","received_events_url":"https://api.github.com/users/tautschnig/received_events","type":"User","site_admin":false},{"login":"kroening","id":1830565,"node_id":"MDQ6VXNlcjE4MzA1NjU=","avatar_url":"https://avatars0.githubusercontent.com/u/1830565?v=4","gravatar_id":"","url":"https://api.github.com/users/kroening","html_url":"https://github.com/kroening","followers_url":"https://api.github.com/users/kroening/followers","following_url":"https://api.github.com/users/kroening/following{/other_user}","gists_url":"https://api.github.com/users/kroening/gists{/gist_id}","starred_url":"https://api.github.com/users/kroening/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/kroening/subscriptions","organizations_url":"https://api.github.com/users/kroening/orgs","repos_url":"https://api.github.com/users/kroening/repos","events_url":"https://api.github.com/users/kroening/events{/privacy}","received_events_url":"https://api.github.com/users/kroening/received_events","type":"User","site_admin":false},{"login":"peterschrammel","id":4222448,"node_id":"MDQ6VXNlcjQyMjI0NDg=","avatar_url":"https://avatars3.githubusercontent.com/u/4222448?v=4","gravatar_id":"","url":"https://api.github.com/users/peterschrammel","html_url":"https://github.com/peterschrammel","followers_url":"https://api.github.com/users/peterschrammel/followers","following_url":"https://api.github.com/users/peterschrammel/following{/other_user}","gists_url":"https://api.github.com/users/peterschrammel/gists{/gist_id}","starred_url":"https://api.github.com/users/peterschrammel/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/peterschrammel/subscriptions","organizations_url":"https://api.github.com/users/peterschrammel/orgs","repos_url":"https://api.github.com/users/peterschrammel/repos","events_url":"https://api.github.com/users/peterschrammel/events{/privacy}","received_events_url":"https://api.github.com/users/peterschrammel/received_events","type":"User","site_admin":false}],"requested_teams":[],"labels":[],"milestone":null,"commits_url":"https://api.github.com/repos/diffblue/cbmc/pulls/3393/commits","review_comments_url":"https://api.github.com/repos/diffblue/cbmc/pulls/3393/comments","review_comment_url":"https://api.github.com/repos/diffblue/cbmc/pulls/comments{/number}","comments_url":"https://api.github.com/repos/diffblue/cbmc/issues/3393/comments","statuses_url":"https://api.github.com/repos/diffblue/cbmc/statuses/c0b43dae325d222ccb1fb226979582b7a64d48b2","head":{"label":"xbauch:docu/symex_target","ref":"docu/symex_target","sha":"c0b43dae325d222ccb1fb226979582b7a64d48b2","user":{"login":"xbauch","id":8643050,"node_id":"MDQ6VXNlcjg2NDMwNTA=","avatar_url":"https://avatars1.githubusercontent.com/u/8643050?v=4","gravatar_id":"","url":"https://api.github.com/users/xbauch","html_url":"https://github.com/xbauch","followers_url":"https://api.github.com/users/xbauch/followers","following_url":"https://api.github.com/users/xbauch/following{/other_user}","gists_url":"https://api.github.com/users/xbauch/gists{/gist_id}","starred_url":"https://api.github.com/users/xbauch/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/xbauch/subscriptions","organizations_url":"https://api.github.com/users/xbauch/orgs","repos_url":"https://api.github.com/users/xbauch/repos","events_url":"https://api.github.com/users/xbauch/events{/privacy}","received_events_url":"https://api.github.com/users/xbauch/received_events","type":"User","site_admin":false},"repo":{"id":145581428,"node_id":"MDEwOlJlcG9zaXRvcnkxNDU1ODE0Mjg=","name":"cbmc","full_name":"xbauch/cbmc","private":false,"owner":{"login":"xbauch","id":8643050,"node_id":"MDQ6VXNlcjg2NDMwNTA=","avatar_url":"https://avatars1.githubusercontent.com/u/8643050?v=4","gravatar_id":"","url":"https://api.github.com/users/xbauch","html_url":"https://github.com/xbauch","followers_url":"https://api.github.com/users/xbauch/followers","following_url":"https://api.github.com/users/xbauch/following{/other_user}","gists_url":"https://api.github.com/users/xbauch/gists{/gist_id}","starred_url":"https://api.github.com/users/xbauch/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/xbauch/subscriptions","organizations_url":"https://api.github.com/users/xbauch/orgs","repos_url":"https://api.github.com/users/xbauch/repos","events_url":"https://api.github.com/users/xbauch/events{/privacy}","received_events_url":"https://api.github.com/users/xbauch/received_events","type":"User","site_admin":false},"html_url":"https://github.com/xbauch/cbmc","description":"C Bounded Model Checker","fork":true,"url":"https://api.github.com/repos/xbauch/cbmc","forks_url":"https://api.github.com/repos/xbauch/cbmc/forks","keys_url":"https://api.github.com/repos/xbauch/cbmc/keys{/key_id}","collaborators_url":"https://api.github.com/repos/xbauch/cbmc/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/xbauch/cbmc/teams","hooks_url":"https://api.github.com/repos/xbauch/cbmc/hooks","issue_events_url":"https://api.github.com/repos/xbauch/cbmc/issues/events{/number}","events_url":"https://api.github.com/repos/xbauch/cbmc/events","assignees_url":"https://api.github.com/repos/xbauch/cbmc/assignees{/user}","branches_url":"https://api.github.com/repos/xbauch/cbmc/branches{/branch}","tags_url":"https://api.github.com/repos/xbauch/cbmc/tags","blobs_url":"https://api.github.com/repos/xbauch/cbmc/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/xbauch/cbmc/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/xbauch/cbmc/git/refs{/sha}","trees_url":"https://api.github.com/repos/xbauch/cbmc/git/trees{/sha}","statuses_url":"https://api.github.com/repos/xbauch/cbmc/statuses/{sha}","languages_url":"https://api.github.com/repos/xbauch/cbmc/languages","stargazers_url":"https://api.github.com/repos/xbauch/cbmc/stargazers","contributors_url":"https://api.github.com/repos/xbauch/cbmc/contributors","subscribers_url":"https://api.github.com/repos/xbauch/cbmc/subscribers","subscription_url":"https://api.github.com/repos/xbauch/cbmc/subscription","commits_url":"https://api.github.com/repos/xbauch/cbmc/commits{/sha}","git_commits_url":"https://api.github.com/repos/xbauch/cbmc/git/commits{/sha}","comments_url":"https://api.github.com/repos/xbauch/cbmc/comments{/number}","issue_comment_url":"https://api.github.com/repos/xbauch/cbmc/issues/comments{/number}","contents_url":"https://api.github.com/repos/xbauch/cbmc/contents/{+path}","compare_url":"https://api.github.com/repos/xbauch/cbmc/compare/{base}...{head}","merges_url":"https://api.github.com/repos/xbauch/cbmc/merges","archive_url":"https://api.github.com/repos/xbauch/cbmc/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/xbauch/cbmc/downloads","issues_url":"https://api.github.com/repos/xbauch/cbmc/issues{/number}","pulls_url":"https://api.github.com/repos/xbauch/cbmc/pulls{/number}","milestones_url":"https://api.github.com/repos/xbauch/cbmc/milestones{/number}","notifications_url":"https://api.github.com/repos/xbauch/cbmc/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/xbauch/cbmc/labels{/name}","releases_url":"https://api.github.com/repos/xbauch/cbmc/releases{/id}","deployments_url":"https://api.github.com/repos/xbauch/cbmc/deployments","created_at":"2018-08-21T15:12:17Z","updated_at":"2018-10-02T09:55:53Z","pushed_at":"2018-11-13T16:12:20Z","git_url":"git://github.com/xbauch/cbmc.git","ssh_url":"git@github.com:xbauch/cbmc.git","clone_url":"https://github.com/xbauch/cbmc.git","svn_url":"https://github.com/xbauch/cbmc","homepage":"http://www.cprover.org/cbmc","size":38734,"stargazers_count":0,"watchers_count":0,"language":"C++","has_issues":false,"has_projects":true,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":0,"mirror_url":null,"archived":false,"open_issues_count":0,"license":{"key":"other","name":"Other","spdx_id":"NOASSERTION","url":null,"node_id":"MDc6TGljZW5zZTA="},"forks":0,"open_issues":0,"watchers":0,"default_branch":"develop"}},"base":{"label":"diffblue:develop","ref":"develop","sha":"4bca13b9eaba8926bbfdd858a996a3bff7daaf41","user":{"login":"diffblue","id":17216098,"node_id":"MDEyOk9yZ2FuaXphdGlvbjE3MjE2MDk4","avatar_url":"https://avatars0.githubusercontent.com/u/17216098?v=4","gravatar_id":"","url":"https://api.github.com/users/diffblue","html_url":"https://github.com/diffblue","followers_url":"https://api.github.com/users/diffblue/followers","following_url":"https://api.github.com/users/diffblue/following{/other_user}","gists_url":"https://api.github.com/users/diffblue/gists{/gist_id}","starred_url":"https://api.github.com/users/diffblue/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/diffblue/subscriptions","organizations_url":"https://api.github.com/users/diffblue/orgs","repos_url":"https://api.github.com/users/diffblue/repos","events_url":"https://api.github.com/users/diffblue/events{/privacy}","received_events_url":"https://api.github.com/users/diffblue/received_events","type":"Organization","site_admin":false},"repo":{"id":51877056,"node_id":"MDEwOlJlcG9zaXRvcnk1MTg3NzA1Ng==","name":"cbmc","full_name":"diffblue/cbmc","private":false,"owner":{"login":"diffblue","id":17216098,"node_id":"MDEyOk9yZ2FuaXphdGlvbjE3MjE2MDk4","avatar_url":"https://avatars0.githubusercontent.com/u/17216098?v=4","gravatar_id":"","url":"https://api.github.com/users/diffblue","html_url":"https://github.com/diffblue","followers_url":"https://api.github.com/users/diffblue/followers","following_url":"https://api.github.com/users/diffblue/following{/other_user}","gists_url":"https://api.github.com/users/diffblue/gists{/gist_id}","starred_url":"https://api.github.com/users/diffblue/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/diffblue/subscriptions","organizations_url":"https://api.github.com/users/diffblue/orgs","repos_url":"https://api.github.com/users/diffblue/repos","events_url":"https://api.github.com/users/diffblue/events{/privacy}","received_events_url":"https://api.github.com/users/diffblue/received_events","type":"Organization","site_admin":false},"html_url":"https://github.com/diffblue/cbmc","description":"C Bounded Model Checker","fork":false,"url":"https://api.github.com/repos/diffblue/cbmc","forks_url":"https://api.github.com/repos/diffblue/cbmc/forks","keys_url":"https://api.github.com/repos/diffblue/cbmc/keys{/key_id}","collaborators_url":"https://api.github.com/repos/diffblue/cbmc/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/diffblue/cbmc/teams","hooks_url":"https://api.github.com/repos/diffblue/cbmc/hooks","issue_events_url":"https://api.github.com/repos/diffblue/cbmc/issues/events{/number}","events_url":"https://api.github.com/repos/diffblue/cbmc/events","assignees_url":"https://api.github.com/repos/diffblue/cbmc/assignees{/user}","branches_url":"https://api.github.com/repos/diffblue/cbmc/branches{/branch}","tags_url":"https://api.github.com/repos/diffblue/cbmc/tags","blobs_url":"https://api.github.com/repos/diffblue/cbmc/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/diffblue/cbmc/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/diffblue/cbmc/git/refs{/sha}","trees_url":"https://api.github.com/repos/diffblue/cbmc/git/trees{/sha}","statuses_url":"https://api.github.com/repos/diffblue/cbmc/statuses/{sha}","languages_url":"https://api.github.com/repos/diffblue/cbmc/languages","stargazers_url":"https://api.github.com/repos/diffblue/cbmc/stargazers","contributors_url":"https://api.github.com/repos/diffblue/cbmc/contributors","subscribers_url":"https://api.github.com/repos/diffblue/cbmc/subscribers","subscription_url":"https://api.github.com/repos/diffblue/cbmc/subscription","commits_url":"https://api.github.com/repos/diffblue/cbmc/commits{/sha}","git_commits_url":"https://api.github.com/repos/diffblue/cbmc/git/commits{/sha}","comments_url":"https://api.github.com/repos/diffblue/cbmc/comments{/number}","issue_comment_url":"https://api.github.com/repos/diffblue/cbmc/issues/comments{/number}","contents_url":"https://api.github.com/repos/diffblue/cbmc/contents/{+path}","compare_url":"https://api.github.com/repos/diffblue/cbmc/compare/{base}...{head}","merges_url":"https://api.github.com/repos/diffblue/cbmc/merges","archive_url":"https://api.github.com/repos/diffblue/cbmc/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/diffblue/cbmc/downloads","issues_url":"https://api.github.com/repos/diffblue/cbmc/issues{/number}","pulls_url":"https://api.github.com/repos/diffblue/cbmc/pulls{/number}","milestones_url":"https://api.github.com/repos/diffblue/cbmc/milestones{/number}","notifications_url":"https://api.github.com/repos/diffblue/cbmc/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/diffblue/cbmc/labels{/name}","releases_url":"https://api.github.com/repos/diffblue/cbmc/releases{/id}","deployments_url":"https://api.github.com/repos/diffblue/cbmc/deployments","created_at":"2016-02-16T23:03:52Z","updated_at":"2018-11-13T16:07:02Z","pushed_at":"2018-11-13T16:31:44Z","git_url":"git://github.com/diffblue/cbmc.git","ssh_url":"git@github.com:diffblue/cbmc.git","clone_url":"https://github.com/diffblue/cbmc.git","svn_url":"https://github.com/diffblue/cbmc","homepage":"http://www.cprover.org/cbmc","size":38684,"stargazers_count":163,"watchers_count":163,"language":"C++","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":112,"mirror_url":null,"archived":false,"open_issues_count":489,"license":{"key":"other","name":"Other","spdx_id":"NOASSERTION","url":null,"node_id":"MDc6TGljZW5zZTA="},"forks":112,"open_issues":489,"watchers":163,"default_branch":"develop"}},"_links":{"self":{"href":"https://api.github.com/repos/diffblue/cbmc/pulls/3393"},"html":{"href":"https://github.com/diffblue/cbmc/pull/3393"},"issue":{"href":"https://api.github.com/repos/diffblue/cbmc/issues/3393"},"comments":{"href":"https://api.github.com/repos/diffblue/cbmc/issues/3393/comments"},"review_comments":{"href":"https://api.github.com/repos/diffblue/cbmc/pulls/3393/comments"},"review_comment":{"href":"https://api.github.com/repos/diffblue/cbmc/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/diffblue/cbmc/pulls/3393/commits"},"statuses":{"href":"https://api.github.com/repos/diffblue/cbmc/statuses/c0b43dae325d222ccb1fb226979582b7a64d48b2"}},"author_association":"CONTRIBUTOR"}}
{"actor":{"display_login":"svorenova"}}