{"action":"closed","number":1328,"pull_request":{"url":"https://api.github.com/repos/fish-shell/fish-shell/pulls/1328","id":13206584,"html_url":"https://github.com/fish-shell/fish-shell/pull/1328","diff_url":"https://github.com/fish-shell/fish-shell/pull/1328.diff","patch_url":"https://github.com/fish-shell/fish-shell/pull/1328.patch","issue_url":"https://api.github.com/repos/fish-shell/fish-shell/issues/1328","number":1328,"state":"closed","locked":false,"title":"Fix, regluarize, and add file comments.","user":{"login":"geoff-codes","id":3162811,"avatar_url":"https://avatars.githubusercontent.com/u/3162811?v=3","gravatar_id":"","url":"https://api.github.com/users/geoff-codes","html_url":"https://github.com/geoff-codes","followers_url":"https://api.github.com/users/geoff-codes/followers","following_url":"https://api.github.com/users/geoff-codes/following{/other_user}","gists_url":"https://api.github.com/users/geoff-codes/gists{/gist_id}","starred_url":"https://api.github.com/users/geoff-codes/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/geoff-codes/subscriptions","organizations_url":"https://api.github.com/users/geoff-codes/orgs","repos_url":"https://api.github.com/users/geoff-codes/repos","events_url":"https://api.github.com/users/geoff-codes/events{/privacy}","received_events_url":"https://api.github.com/users/geoff-codes/received_events","type":"User","site_admin":false},"body":"Second go at comment fixes from #1317.\r\n\r\nNo intended functionality change or changes to code (besides documentation generation, obviously).\r\nDone by hand (with a little bit of help from `grep` and `sed`). But *please* review before merge.\r\n\r\nIntroductory comments have been regularized to:\r\n```\r\n/** \\file foobar.[cpp|h]\r\n    Four spaces, one line not longer than 78 characters, ending in a period.\r\n*/\r\n\r\n(^ Newline. ^)\r\n```\r\n- Many files lacked these entirely; I have done my best to summarize these files accurately.\r\n- `Doxyfile` has been changed to properly account for C++ classes: `OPTIMIZE_OUTPUT_FOR_C = NO`.\r\n- The database generated when doxygen 1.8.5+ is linked to sqlite has been added to `.gitignore`.\r\n- A few other minor changes to comments and whitespace: typos, etc. No removals except for these:\r\n`#ifndef FISH_HEADER_H`  \r\n__`/**`__  \r\n__`   Header guard`__  \r\n__`*/`__  \r\n`#define FISH_HEADER_H`  \r\n\r\nAlso:\r\n- Note that _many_ comments lack javadoc style `/**`s, and therefore do not appear in documentation.\r\n- Much of the code does not conform to `CONTRIBUTING.md`: in particular, use of hard tabs.\r\n- Not sure it really matters, but the includes are all still in C `stdlib.h` form rather than `cstdlib`, etc.\r\n- The current HEAD has disassociated from the 2.1.0 release tag, and this causes \r\n  `FISH_BUILD_VERSION`  (for me, at least) to be generated as `1.23.1-1996-XXXXXX`.  \r\n   Someone maybe should push a new tag to (2.1.X, 2.2.0, or whatnot) to rectify this?\r\n\r\nSince the last time I tried to use clang tooling it caused a serious regression, it won't be me, but I'd strongly urge the consideration of a pass or two through `clang-tidy`, `clang-format`, and/or `clang-modernize` to help clean up some.","created_at":"2014-03-05T11:33:26Z","updated_at":"2015-09-02T12:08:02Z","closed_at":"2015-09-02T12:08:02Z","merged_at":null,"merge_commit_sha":"bac06d646f53ad25889a5feddfd74beeb635120d","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/fish-shell/fish-shell/pulls/1328/commits","review_comments_url":"https://api.github.com/repos/fish-shell/fish-shell/pulls/1328/comments","review_comment_url":"https://api.github.com/repos/fish-shell/fish-shell/pulls/comments{/number}","comments_url":"https://api.github.com/repos/fish-shell/fish-shell/issues/1328/comments","statuses_url":"https://api.github.com/repos/fish-shell/fish-shell/statuses/af099357fe1383a223b4ca514db5044e0d3ce173","head":{"label":"pullreq:comments","ref":"comments","sha":"af099357fe1383a223b4ca514db5044e0d3ce173","user":{"login":"pullreq","id":6166084,"avatar_url":"https://avatars.githubusercontent.com/u/6166084?v=3","gravatar_id":"","url":"https://api.github.com/users/pullreq","html_url":"https://github.com/pullreq","followers_url":"https://api.github.com/users/pullreq/followers","following_url":"https://api.github.com/users/pullreq/following{/other_user}","gists_url":"https://api.github.com/users/pullreq/gists{/gist_id}","starred_url":"https://api.github.com/users/pullreq/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/pullreq/subscriptions","organizations_url":"https://api.github.com/users/pullreq/orgs","repos_url":"https://api.github.com/users/pullreq/repos","events_url":"https://api.github.com/users/pullreq/events{/privacy}","received_events_url":"https://api.github.com/users/pullreq/received_events","type":"Organization","site_admin":false},"repo":{"id":15703970,"name":"fish-shell","full_name":"pullreq/fish-shell","owner":{"login":"pullreq","id":6166084,"avatar_url":"https://avatars.githubusercontent.com/u/6166084?v=3","gravatar_id":"","url":"https://api.github.com/users/pullreq","html_url":"https://github.com/pullreq","followers_url":"https://api.github.com/users/pullreq/followers","following_url":"https://api.github.com/users/pullreq/following{/other_user}","gists_url":"https://api.github.com/users/pullreq/gists{/gist_id}","starred_url":"https://api.github.com/users/pullreq/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/pullreq/subscriptions","organizations_url":"https://api.github.com/users/pullreq/orgs","repos_url":"https://api.github.com/users/pullreq/repos","events_url":"https://api.github.com/users/pullreq/events{/privacy}","received_events_url":"https://api.github.com/users/pullreq/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/pullreq/fish-shell","description":"The user-friendly command line shell.","fork":true,"url":"https://api.github.com/repos/pullreq/fish-shell","forks_url":"https://api.github.com/repos/pullreq/fish-shell/forks","keys_url":"https://api.github.com/repos/pullreq/fish-shell/keys{/key_id}","collaborators_url":"https://api.github.com/repos/pullreq/fish-shell/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/pullreq/fish-shell/teams","hooks_url":"https://api.github.com/repos/pullreq/fish-shell/hooks","issue_events_url":"https://api.github.com/repos/pullreq/fish-shell/issues/events{/number}","events_url":"https://api.github.com/repos/pullreq/fish-shell/events","assignees_url":"https://api.github.com/repos/pullreq/fish-shell/assignees{/user}","branches_url":"https://api.github.com/repos/pullreq/fish-shell/branches{/branch}","tags_url":"https://api.github.com/repos/pullreq/fish-shell/tags","blobs_url":"https://api.github.com/repos/pullreq/fish-shell/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/pullreq/fish-shell/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/pullreq/fish-shell/git/refs{/sha}","trees_url":"https://api.github.com/repos/pullreq/fish-shell/git/trees{/sha}","statuses_url":"https://api.github.com/repos/pullreq/fish-shell/statuses/{sha}","languages_url":"https://api.github.com/repos/pullreq/fish-shell/languages","stargazers_url":"https://api.github.com/repos/pullreq/fish-shell/stargazers","contributors_url":"https://api.github.com/repos/pullreq/fish-shell/contributors","subscribers_url":"https://api.github.com/repos/pullreq/fish-shell/subscribers","subscription_url":"https://api.github.com/repos/pullreq/fish-shell/subscription","commits_url":"https://api.github.com/repos/pullreq/fish-shell/commits{/sha}","git_commits_url":"https://api.github.com/repos/pullreq/fish-shell/git/commits{/sha}","comments_url":"https://api.github.com/repos/pullreq/fish-shell/comments{/number}","issue_comment_url":"https://api.github.com/repos/pullreq/fish-shell/issues/comments{/number}","contents_url":"https://api.github.com/repos/pullreq/fish-shell/contents/{+path}","compare_url":"https://api.github.com/repos/pullreq/fish-shell/compare/{base}...{head}","merges_url":"https://api.github.com/repos/pullreq/fish-shell/merges","archive_url":"https://api.github.com/repos/pullreq/fish-shell/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/pullreq/fish-shell/downloads","issues_url":"https://api.github.com/repos/pullreq/fish-shell/issues{/number}","pulls_url":"https://api.github.com/repos/pullreq/fish-shell/pulls{/number}","milestones_url":"https://api.github.com/repos/pullreq/fish-shell/milestones{/number}","notifications_url":"https://api.github.com/repos/pullreq/fish-shell/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/pullreq/fish-shell/labels{/name}","releases_url":"https://api.github.com/repos/pullreq/fish-shell/releases{/id}","created_at":"2014-01-07T12:34:08Z","updated_at":"2014-03-05T12:22:03Z","pushed_at":"2014-03-05T12:22:02Z","git_url":"git://github.com/pullreq/fish-shell.git","ssh_url":"git@github.com:pullreq/fish-shell.git","clone_url":"https://github.com/pullreq/fish-shell.git","svn_url":"https://github.com/pullreq/fish-shell","homepage":"","size":20092,"stargazers_count":0,"watchers_count":0,"language":"C++","has_issues":false,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":0,"forks":0,"open_issues":0,"watchers":0,"default_branch":"builtin-curses-and-terminfo"}},"base":{"label":"fish-shell:master","ref":"master","sha":"fbe28fd5d8274c298c825428d89fbe20f4ae111e","user":{"login":"fish-shell","id":1828073,"avatar_url":"https://avatars.githubusercontent.com/u/1828073?v=3","gravatar_id":"","url":"https://api.github.com/users/fish-shell","html_url":"https://github.com/fish-shell","followers_url":"https://api.github.com/users/fish-shell/followers","following_url":"https://api.github.com/users/fish-shell/following{/other_user}","gists_url":"https://api.github.com/users/fish-shell/gists{/gist_id}","starred_url":"https://api.github.com/users/fish-shell/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/fish-shell/subscriptions","organizations_url":"https://api.github.com/users/fish-shell/orgs","repos_url":"https://api.github.com/users/fish-shell/repos","events_url":"https://api.github.com/users/fish-shell/events{/privacy}","received_events_url":"https://api.github.com/users/fish-shell/received_events","type":"Organization","site_admin":false},"repo":{"id":4279682,"name":"fish-shell","full_name":"fish-shell/fish-shell","owner":{"login":"fish-shell","id":1828073,"avatar_url":"https://avatars.githubusercontent.com/u/1828073?v=3","gravatar_id":"","url":"https://api.github.com/users/fish-shell","html_url":"https://github.com/fish-shell","followers_url":"https://api.github.com/users/fish-shell/followers","following_url":"https://api.github.com/users/fish-shell/following{/other_user}","gists_url":"https://api.github.com/users/fish-shell/gists{/gist_id}","starred_url":"https://api.github.com/users/fish-shell/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/fish-shell/subscriptions","organizations_url":"https://api.github.com/users/fish-shell/orgs","repos_url":"https://api.github.com/users/fish-shell/repos","events_url":"https://api.github.com/users/fish-shell/events{/privacy}","received_events_url":"https://api.github.com/users/fish-shell/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/fish-shell/fish-shell","description":"The user-friendly command line shell.","fork":false,"url":"https://api.github.com/repos/fish-shell/fish-shell","forks_url":"https://api.github.com/repos/fish-shell/fish-shell/forks","keys_url":"https://api.github.com/repos/fish-shell/fish-shell/keys{/key_id}","collaborators_url":"https://api.github.com/repos/fish-shell/fish-shell/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/fish-shell/fish-shell/teams","hooks_url":"https://api.github.com/repos/fish-shell/fish-shell/hooks","issue_events_url":"https://api.github.com/repos/fish-shell/fish-shell/issues/events{/number}","events_url":"https://api.github.com/repos/fish-shell/fish-shell/events","assignees_url":"https://api.github.com/repos/fish-shell/fish-shell/assignees{/user}","branches_url":"https://api.github.com/repos/fish-shell/fish-shell/branches{/branch}","tags_url":"https://api.github.com/repos/fish-shell/fish-shell/tags","blobs_url":"https://api.github.com/repos/fish-shell/fish-shell/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/fish-shell/fish-shell/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/fish-shell/fish-shell/git/refs{/sha}","trees_url":"https://api.github.com/repos/fish-shell/fish-shell/git/trees{/sha}","statuses_url":"https://api.github.com/repos/fish-shell/fish-shell/statuses/{sha}","languages_url":"https://api.github.com/repos/fish-shell/fish-shell/languages","stargazers_url":"https://api.github.com/repos/fish-shell/fish-shell/stargazers","contributors_url":"https://api.github.com/repos/fish-shell/fish-shell/contributors","subscribers_url":"https://api.github.com/repos/fish-shell/fish-shell/subscribers","subscription_url":"https://api.github.com/repos/fish-shell/fish-shell/subscription","commits_url":"https://api.github.com/repos/fish-shell/fish-shell/commits{/sha}","git_commits_url":"https://api.github.com/repos/fish-shell/fish-shell/git/commits{/sha}","comments_url":"https://api.github.com/repos/fish-shell/fish-shell/comments{/number}","issue_comment_url":"https://api.github.com/repos/fish-shell/fish-shell/issues/comments{/number}","contents_url":"https://api.github.com/repos/fish-shell/fish-shell/contents/{+path}","compare_url":"https://api.github.com/repos/fish-shell/fish-shell/compare/{base}...{head}","merges_url":"https://api.github.com/repos/fish-shell/fish-shell/merges","archive_url":"https://api.github.com/repos/fish-shell/fish-shell/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/fish-shell/fish-shell/downloads","issues_url":"https://api.github.com/repos/fish-shell/fish-shell/issues{/number}","pulls_url":"https://api.github.com/repos/fish-shell/fish-shell/pulls{/number}","milestones_url":"https://api.github.com/repos/fish-shell/fish-shell/milestones{/number}","notifications_url":"https://api.github.com/repos/fish-shell/fish-shell/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/fish-shell/fish-shell/labels{/name}","releases_url":"https://api.github.com/repos/fish-shell/fish-shell/releases{/id}","created_at":"2012-05-10T03:00:55Z","updated_at":"2015-09-02T03:42:04Z","pushed_at":"2015-09-02T11:59:41Z","git_url":"git://github.com/fish-shell/fish-shell.git","ssh_url":"git@github.com:fish-shell/fish-shell.git","clone_url":"https://github.com/fish-shell/fish-shell.git","svn_url":"https://github.com/fish-shell/fish-shell","homepage":"http://fishshell.com","size":39908,"stargazers_count":4557,"watchers_count":4557,"language":"C++","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":432,"mirror_url":null,"open_issues_count":620,"forks":432,"open_issues":620,"watchers":4557,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/fish-shell/fish-shell/pulls/1328"},"html":{"href":"https://github.com/fish-shell/fish-shell/pull/1328"},"issue":{"href":"https://api.github.com/repos/fish-shell/fish-shell/issues/1328"},"comments":{"href":"https://api.github.com/repos/fish-shell/fish-shell/issues/1328/comments"},"review_comments":{"href":"https://api.github.com/repos/fish-shell/fish-shell/pulls/1328/comments"},"review_comment":{"href":"https://api.github.com/repos/fish-shell/fish-shell/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/fish-shell/fish-shell/pulls/1328/commits"},"statuses":{"href":"https://api.github.com/repos/fish-shell/fish-shell/statuses/af099357fe1383a223b4ca514db5044e0d3ce173"}},"merged":false,"mergeable":false,"mergeable_state":"dirty","merged_by":null,"comments":3,"review_comments":0,"commits":1,"additions":372,"deletions":310,"changed_files":116}}