{"action":"created","comment":{"url":"https://api.github.com/repos/SpineEventEngine/tools/pulls/comments/108219472","pull_request_review_id":29232041,"id":108219472,"diff_hunk":"@@ -0,0 +1,25 @@\n+/*\n+ * Copyright 2017, TeamDev Ltd. All rights reserved.\n+ *\n+ * Redistribution and use in source and/or binary forms, with or without\n+ * modification, must retain the above copyright notice and the following\n+ * disclaimer.\n+ *\n+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\n+ * \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\n+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR\n+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT\n+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,\n+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT\n+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,\n+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY\n+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\n+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\n+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n+ */\n+\n+/**\n+ * Utilities for working with Javadoc.\n+ */\n+package org.spine3.gradle.protobuf.javadoc;","path":"protobuf-plugin/plugin/src/main/java/org/spine3/gradle/protobuf/javadoc/package-info.java","position":24,"original_position":24,"commit_id":"dec9589a216fe59ae2ee820aacf5e5756c2e85b2","original_commit_id":"dec9589a216fe59ae2ee820aacf5e5756c2e85b2","user":{"login":"armiol","id":82468,"avatar_url":"https://avatars3.githubusercontent.com/u/82468?v=3","gravatar_id":"","url":"https://api.github.com/users/armiol","html_url":"https://github.com/armiol","followers_url":"https://api.github.com/users/armiol/followers","following_url":"https://api.github.com/users/armiol/following{/other_user}","gists_url":"https://api.github.com/users/armiol/gists{/gist_id}","starred_url":"https://api.github.com/users/armiol/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/armiol/subscriptions","organizations_url":"https://api.github.com/users/armiol/orgs","repos_url":"https://api.github.com/users/armiol/repos","events_url":"https://api.github.com/users/armiol/events{/privacy}","received_events_url":"https://api.github.com/users/armiol/received_events","type":"User","site_admin":false},"body":"Please consider adding `import javax.annotation.ParametersAreNonnullByDefault;`.\r\n\r\nReview the rest of packages used in this PR for the same flaw.","created_at":"2017-03-27T16:45:08Z","updated_at":"2017-03-27T16:49:40Z","html_url":"https://github.com/SpineEventEngine/tools/pull/59#discussion_r108219472","pull_request_url":"https://api.github.com/repos/SpineEventEngine/tools/pulls/59","_links":{"self":{"href":"https://api.github.com/repos/SpineEventEngine/tools/pulls/comments/108219472"},"html":{"href":"https://github.com/SpineEventEngine/tools/pull/59#discussion_r108219472"},"pull_request":{"href":"https://api.github.com/repos/SpineEventEngine/tools/pulls/59"}}},"pull_request":{"url":"https://api.github.com/repos/SpineEventEngine/tools/pulls/59","id":111827991,"html_url":"https://github.com/SpineEventEngine/tools/pull/59","diff_url":"https://github.com/SpineEventEngine/tools/pull/59.diff","patch_url":"https://github.com/SpineEventEngine/tools/pull/59.patch","issue_url":"https://api.github.com/repos/SpineEventEngine/tools/issues/59","number":59,"state":"open","locked":false,"title":"Failures Javadoc","user":{"login":"dmytro-grankin","id":25301769,"avatar_url":"https://avatars1.githubusercontent.com/u/25301769?v=3","gravatar_id":"","url":"https://api.github.com/users/dmytro-grankin","html_url":"https://github.com/dmytro-grankin","followers_url":"https://api.github.com/users/dmytro-grankin/followers","following_url":"https://api.github.com/users/dmytro-grankin/following{/other_user}","gists_url":"https://api.github.com/users/dmytro-grankin/gists{/gist_id}","starred_url":"https://api.github.com/users/dmytro-grankin/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dmytro-grankin/subscriptions","organizations_url":"https://api.github.com/users/dmytro-grankin/orgs","repos_url":"https://api.github.com/users/dmytro-grankin/repos","events_url":"https://api.github.com/users/dmytro-grankin/events{/privacy}","received_events_url":"https://api.github.com/users/dmytro-grankin/received_events","type":"User","site_admin":false},"body":"As we generate the failures based on protobuf messages, we also should generate the Javadocs with the comments from the message definition. This change makes the generated code more readable and convenient.\r\n\r\nSummary:\r\n- Add class-level Javadoc generation.\r\n- Add constructor-level Javadoc generation.\r\n\r\nFor example, for the following failure definition\r\n\r\n```\r\n// Failure description.\r\nmessage Failure {\r\n\r\n    // The failure ID.\r\n    int32 id = 1;\r\n\r\n    // The failure message.\r\n    string message = 2;\r\n}\r\n```\r\n\r\nGenerated failure Javadoc should look like\r\n\r\n```java\r\n/**\r\n * <pre>\r\n *  Failure description.\r\n * </pre>\r\n *\r\n * Failure based on protobuf type {@code package.Failure}\r\n */\r\n@Generated(\"by Spine compiler\")\r\npublic class Failure extends FailureThrowable {\r\n    private static final long serialVersionUID = 0L;\r\n\r\n    /**\r\n     * Creates a new instance.\r\n     *\r\n     * @param id       The failure ID.\r\n     * @param message  The failure message.\r\n     */\r\n    public Failure(GeneratedMessageV3 commandMessage, CommandContext commandContext,\r\n            int id, String message) {\r\n        // initialization...\r\n    }\r\n\r\n    // remaining part omitted\r\n}\r\n```","created_at":"2017-03-21T16:55:13Z","updated_at":"2017-03-27T16:49:40Z","closed_at":null,"merged_at":null,"merge_commit_sha":"3ba838004be359f1e45f9810305fddb72586da84","assignee":{"login":"dmytro-grankin","id":25301769,"avatar_url":"https://avatars1.githubusercontent.com/u/25301769?v=3","gravatar_id":"","url":"https://api.github.com/users/dmytro-grankin","html_url":"https://github.com/dmytro-grankin","followers_url":"https://api.github.com/users/dmytro-grankin/followers","following_url":"https://api.github.com/users/dmytro-grankin/following{/other_user}","gists_url":"https://api.github.com/users/dmytro-grankin/gists{/gist_id}","starred_url":"https://api.github.com/users/dmytro-grankin/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dmytro-grankin/subscriptions","organizations_url":"https://api.github.com/users/dmytro-grankin/orgs","repos_url":"https://api.github.com/users/dmytro-grankin/repos","events_url":"https://api.github.com/users/dmytro-grankin/events{/privacy}","received_events_url":"https://api.github.com/users/dmytro-grankin/received_events","type":"User","site_admin":false},"assignees":[{"login":"dmytro-grankin","id":25301769,"avatar_url":"https://avatars1.githubusercontent.com/u/25301769?v=3","gravatar_id":"","url":"https://api.github.com/users/dmytro-grankin","html_url":"https://github.com/dmytro-grankin","followers_url":"https://api.github.com/users/dmytro-grankin/followers","following_url":"https://api.github.com/users/dmytro-grankin/following{/other_user}","gists_url":"https://api.github.com/users/dmytro-grankin/gists{/gist_id}","starred_url":"https://api.github.com/users/dmytro-grankin/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dmytro-grankin/subscriptions","organizations_url":"https://api.github.com/users/dmytro-grankin/orgs","repos_url":"https://api.github.com/users/dmytro-grankin/repos","events_url":"https://api.github.com/users/dmytro-grankin/events{/privacy}","received_events_url":"https://api.github.com/users/dmytro-grankin/received_events","type":"User","site_admin":false}],"milestone":null,"commits_url":"https://api.github.com/repos/SpineEventEngine/tools/pulls/59/commits","review_comments_url":"https://api.github.com/repos/SpineEventEngine/tools/pulls/59/comments","review_comment_url":"https://api.github.com/repos/SpineEventEngine/tools/pulls/comments{/number}","comments_url":"https://api.github.com/repos/SpineEventEngine/tools/issues/59/comments","statuses_url":"https://api.github.com/repos/SpineEventEngine/tools/statuses/dec9589a216fe59ae2ee820aacf5e5756c2e85b2","head":{"label":"SpineEventEngine:failures-javadoc","ref":"failures-javadoc","sha":"dec9589a216fe59ae2ee820aacf5e5756c2e85b2","user":{"login":"SpineEventEngine","id":12821626,"avatar_url":"https://avatars0.githubusercontent.com/u/12821626?v=3","gravatar_id":"","url":"https://api.github.com/users/SpineEventEngine","html_url":"https://github.com/SpineEventEngine","followers_url":"https://api.github.com/users/SpineEventEngine/followers","following_url":"https://api.github.com/users/SpineEventEngine/following{/other_user}","gists_url":"https://api.github.com/users/SpineEventEngine/gists{/gist_id}","starred_url":"https://api.github.com/users/SpineEventEngine/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/SpineEventEngine/subscriptions","organizations_url":"https://api.github.com/users/SpineEventEngine/orgs","repos_url":"https://api.github.com/users/SpineEventEngine/repos","events_url":"https://api.github.com/users/SpineEventEngine/events{/privacy}","received_events_url":"https://api.github.com/users/SpineEventEngine/received_events","type":"Organization","site_admin":false},"repo":{"id":42251175,"name":"tools","full_name":"SpineEventEngine/tools","owner":{"login":"SpineEventEngine","id":12821626,"avatar_url":"https://avatars0.githubusercontent.com/u/12821626?v=3","gravatar_id":"","url":"https://api.github.com/users/SpineEventEngine","html_url":"https://github.com/SpineEventEngine","followers_url":"https://api.github.com/users/SpineEventEngine/followers","following_url":"https://api.github.com/users/SpineEventEngine/following{/other_user}","gists_url":"https://api.github.com/users/SpineEventEngine/gists{/gist_id}","starred_url":"https://api.github.com/users/SpineEventEngine/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/SpineEventEngine/subscriptions","organizations_url":"https://api.github.com/users/SpineEventEngine/orgs","repos_url":"https://api.github.com/users/SpineEventEngine/repos","events_url":"https://api.github.com/users/SpineEventEngine/events{/privacy}","received_events_url":"https://api.github.com/users/SpineEventEngine/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/SpineEventEngine/tools","description":"Code generation and veritifcation tools","fork":false,"url":"https://api.github.com/repos/SpineEventEngine/tools","forks_url":"https://api.github.com/repos/SpineEventEngine/tools/forks","keys_url":"https://api.github.com/repos/SpineEventEngine/tools/keys{/key_id}","collaborators_url":"https://api.github.com/repos/SpineEventEngine/tools/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/SpineEventEngine/tools/teams","hooks_url":"https://api.github.com/repos/SpineEventEngine/tools/hooks","issue_events_url":"https://api.github.com/repos/SpineEventEngine/tools/issues/events{/number}","events_url":"https://api.github.com/repos/SpineEventEngine/tools/events","assignees_url":"https://api.github.com/repos/SpineEventEngine/tools/assignees{/user}","branches_url":"https://api.github.com/repos/SpineEventEngine/tools/branches{/branch}","tags_url":"https://api.github.com/repos/SpineEventEngine/tools/tags","blobs_url":"https://api.github.com/repos/SpineEventEngine/tools/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/SpineEventEngine/tools/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/SpineEventEngine/tools/git/refs{/sha}","trees_url":"https://api.github.com/repos/SpineEventEngine/tools/git/trees{/sha}","statuses_url":"https://api.github.com/repos/SpineEventEngine/tools/statuses/{sha}","languages_url":"https://api.github.com/repos/SpineEventEngine/tools/languages","stargazers_url":"https://api.github.com/repos/SpineEventEngine/tools/stargazers","contributors_url":"https://api.github.com/repos/SpineEventEngine/tools/contributors","subscribers_url":"https://api.github.com/repos/SpineEventEngine/tools/subscribers","subscription_url":"https://api.github.com/repos/SpineEventEngine/tools/subscription","commits_url":"https://api.github.com/repos/SpineEventEngine/tools/commits{/sha}","git_commits_url":"https://api.github.com/repos/SpineEventEngine/tools/git/commits{/sha}","comments_url":"https://api.github.com/repos/SpineEventEngine/tools/comments{/number}","issue_comment_url":"https://api.github.com/repos/SpineEventEngine/tools/issues/comments{/number}","contents_url":"https://api.github.com/repos/SpineEventEngine/tools/contents/{+path}","compare_url":"https://api.github.com/repos/SpineEventEngine/tools/compare/{base}...{head}","merges_url":"https://api.github.com/repos/SpineEventEngine/tools/merges","archive_url":"https://api.github.com/repos/SpineEventEngine/tools/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/SpineEventEngine/tools/downloads","issues_url":"https://api.github.com/repos/SpineEventEngine/tools/issues{/number}","pulls_url":"https://api.github.com/repos/SpineEventEngine/tools/pulls{/number}","milestones_url":"https://api.github.com/repos/SpineEventEngine/tools/milestones{/number}","notifications_url":"https://api.github.com/repos/SpineEventEngine/tools/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/SpineEventEngine/tools/labels{/name}","releases_url":"https://api.github.com/repos/SpineEventEngine/tools/releases{/id}","deployments_url":"https://api.github.com/repos/SpineEventEngine/tools/deployments","created_at":"2015-09-10T14:54:43Z","updated_at":"2016-12-21T17:29:57Z","pushed_at":"2017-03-27T16:07:05Z","git_url":"git://github.com/SpineEventEngine/tools.git","ssh_url":"git@github.com:SpineEventEngine/tools.git","clone_url":"https://github.com/SpineEventEngine/tools.git","svn_url":"https://github.com/SpineEventEngine/tools","homepage":null,"size":1212,"stargazers_count":0,"watchers_count":0,"language":"Java","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":8,"forks":0,"open_issues":8,"watchers":0,"default_branch":"master"}},"base":{"label":"SpineEventEngine:master","ref":"master","sha":"a24982b65143171b213c1f1c4bec5fb3acc14dd5","user":{"login":"SpineEventEngine","id":12821626,"avatar_url":"https://avatars0.githubusercontent.com/u/12821626?v=3","gravatar_id":"","url":"https://api.github.com/users/SpineEventEngine","html_url":"https://github.com/SpineEventEngine","followers_url":"https://api.github.com/users/SpineEventEngine/followers","following_url":"https://api.github.com/users/SpineEventEngine/following{/other_user}","gists_url":"https://api.github.com/users/SpineEventEngine/gists{/gist_id}","starred_url":"https://api.github.com/users/SpineEventEngine/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/SpineEventEngine/subscriptions","organizations_url":"https://api.github.com/users/SpineEventEngine/orgs","repos_url":"https://api.github.com/users/SpineEventEngine/repos","events_url":"https://api.github.com/users/SpineEventEngine/events{/privacy}","received_events_url":"https://api.github.com/users/SpineEventEngine/received_events","type":"Organization","site_admin":false},"repo":{"id":42251175,"name":"tools","full_name":"SpineEventEngine/tools","owner":{"login":"SpineEventEngine","id":12821626,"avatar_url":"https://avatars0.githubusercontent.com/u/12821626?v=3","gravatar_id":"","url":"https://api.github.com/users/SpineEventEngine","html_url":"https://github.com/SpineEventEngine","followers_url":"https://api.github.com/users/SpineEventEngine/followers","following_url":"https://api.github.com/users/SpineEventEngine/following{/other_user}","gists_url":"https://api.github.com/users/SpineEventEngine/gists{/gist_id}","starred_url":"https://api.github.com/users/SpineEventEngine/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/SpineEventEngine/subscriptions","organizations_url":"https://api.github.com/users/SpineEventEngine/orgs","repos_url":"https://api.github.com/users/SpineEventEngine/repos","events_url":"https://api.github.com/users/SpineEventEngine/events{/privacy}","received_events_url":"https://api.github.com/users/SpineEventEngine/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/SpineEventEngine/tools","description":"Code generation and veritifcation tools","fork":false,"url":"https://api.github.com/repos/SpineEventEngine/tools","forks_url":"https://api.github.com/repos/SpineEventEngine/tools/forks","keys_url":"https://api.github.com/repos/SpineEventEngine/tools/keys{/key_id}","collaborators_url":"https://api.github.com/repos/SpineEventEngine/tools/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/SpineEventEngine/tools/teams","hooks_url":"https://api.github.com/repos/SpineEventEngine/tools/hooks","issue_events_url":"https://api.github.com/repos/SpineEventEngine/tools/issues/events{/number}","events_url":"https://api.github.com/repos/SpineEventEngine/tools/events","assignees_url":"https://api.github.com/repos/SpineEventEngine/tools/assignees{/user}","branches_url":"https://api.github.com/repos/SpineEventEngine/tools/branches{/branch}","tags_url":"https://api.github.com/repos/SpineEventEngine/tools/tags","blobs_url":"https://api.github.com/repos/SpineEventEngine/tools/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/SpineEventEngine/tools/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/SpineEventEngine/tools/git/refs{/sha}","trees_url":"https://api.github.com/repos/SpineEventEngine/tools/git/trees{/sha}","statuses_url":"https://api.github.com/repos/SpineEventEngine/tools/statuses/{sha}","languages_url":"https://api.github.com/repos/SpineEventEngine/tools/languages","stargazers_url":"https://api.github.com/repos/SpineEventEngine/tools/stargazers","contributors_url":"https://api.github.com/repos/SpineEventEngine/tools/contributors","subscribers_url":"https://api.github.com/repos/SpineEventEngine/tools/subscribers","subscription_url":"https://api.github.com/repos/SpineEventEngine/tools/subscription","commits_url":"https://api.github.com/repos/SpineEventEngine/tools/commits{/sha}","git_commits_url":"https://api.github.com/repos/SpineEventEngine/tools/git/commits{/sha}","comments_url":"https://api.github.com/repos/SpineEventEngine/tools/comments{/number}","issue_comment_url":"https://api.github.com/repos/SpineEventEngine/tools/issues/comments{/number}","contents_url":"https://api.github.com/repos/SpineEventEngine/tools/contents/{+path}","compare_url":"https://api.github.com/repos/SpineEventEngine/tools/compare/{base}...{head}","merges_url":"https://api.github.com/repos/SpineEventEngine/tools/merges","archive_url":"https://api.github.com/repos/SpineEventEngine/tools/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/SpineEventEngine/tools/downloads","issues_url":"https://api.github.com/repos/SpineEventEngine/tools/issues{/number}","pulls_url":"https://api.github.com/repos/SpineEventEngine/tools/pulls{/number}","milestones_url":"https://api.github.com/repos/SpineEventEngine/tools/milestones{/number}","notifications_url":"https://api.github.com/repos/SpineEventEngine/tools/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/SpineEventEngine/tools/labels{/name}","releases_url":"https://api.github.com/repos/SpineEventEngine/tools/releases{/id}","deployments_url":"https://api.github.com/repos/SpineEventEngine/tools/deployments","created_at":"2015-09-10T14:54:43Z","updated_at":"2016-12-21T17:29:57Z","pushed_at":"2017-03-27T16:07:05Z","git_url":"git://github.com/SpineEventEngine/tools.git","ssh_url":"git@github.com:SpineEventEngine/tools.git","clone_url":"https://github.com/SpineEventEngine/tools.git","svn_url":"https://github.com/SpineEventEngine/tools","homepage":null,"size":1212,"stargazers_count":0,"watchers_count":0,"language":"Java","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":8,"forks":0,"open_issues":8,"watchers":0,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/SpineEventEngine/tools/pulls/59"},"html":{"href":"https://github.com/SpineEventEngine/tools/pull/59"},"issue":{"href":"https://api.github.com/repos/SpineEventEngine/tools/issues/59"},"comments":{"href":"https://api.github.com/repos/SpineEventEngine/tools/issues/59/comments"},"review_comments":{"href":"https://api.github.com/repos/SpineEventEngine/tools/pulls/59/comments"},"review_comment":{"href":"https://api.github.com/repos/SpineEventEngine/tools/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/SpineEventEngine/tools/pulls/59/commits"},"statuses":{"href":"https://api.github.com/repos/SpineEventEngine/tools/statuses/dec9589a216fe59ae2ee820aacf5e5756c2e85b2"}}}}
{"actor":{"display_login":"armiol"}}