{"action":"created","issue":{"url":"https://api.github.com/repos/nikhilkalige/docblockr/issues/164","repository_url":"https://api.github.com/repos/nikhilkalige/docblockr","labels_url":"https://api.github.com/repos/nikhilkalige/docblockr/issues/164/labels{/name}","comments_url":"https://api.github.com/repos/nikhilkalige/docblockr/issues/164/comments","events_url":"https://api.github.com/repos/nikhilkalige/docblockr/issues/164/events","html_url":"https://github.com/nikhilkalige/docblockr/issues/164","id":134873029,"number":164,"title":"Support doc blocks without leading asterisk","user":{"login":"chriskrycho","id":2403023,"avatar_url":"https://avatars.githubusercontent.com/u/2403023?v=3","gravatar_id":"","url":"https://api.github.com/users/chriskrycho","html_url":"https://github.com/chriskrycho","followers_url":"https://api.github.com/users/chriskrycho/followers","following_url":"https://api.github.com/users/chriskrycho/following{/other_user}","gists_url":"https://api.github.com/users/chriskrycho/gists{/gist_id}","starred_url":"https://api.github.com/users/chriskrycho/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/chriskrycho/subscriptions","organizations_url":"https://api.github.com/users/chriskrycho/orgs","repos_url":"https://api.github.com/users/chriskrycho/repos","events_url":"https://api.github.com/users/chriskrycho/events{/privacy}","received_events_url":"https://api.github.com/users/chriskrycho/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":1,"created_at":"2016-02-19T14:04:06Z","updated_at":"2016-07-21T20:59:47Z","closed_at":null,"body":"There are two common styles of doc blocks in JS these days. The first is the one currently supported by docblockr:\r\n\r\n```js\r\n/**\r\n * This is the current style.\r\n\r\n * @param foo Does a fun thing.\r\n * @return The result of this function.\r\n */\r\nfunction bar(foo) {\r\n   // ...\r\n}\r\n```\r\n\r\nAnother style seems increasingly common, however, and I *very* much prefer it:\r\n\r\n```js\r\n/**\r\n  This is the style used in e.g. Ember.js' docs.\r\n\r\n  @param foo Does a fun thing.\r\n  @return The result of this function\r\n */\r\nfunction bar(foo) {\r\n  // ...\r\n}\r\n```\r\n\r\nI'd love to see support for this style, without the leading asterisks on every line. (If you point me to the relevant spot in the code, I'll even take a look at what it would take to add a setting for it.)"},"comment":{"url":"https://api.github.com/repos/nikhilkalige/docblockr/issues/comments/234382389","html_url":"https://github.com/nikhilkalige/docblockr/issues/164#issuecomment-234382389","issue_url":"https://api.github.com/repos/nikhilkalige/docblockr/issues/164","id":234382389,"user":{"login":"MoritzKn","id":10676525,"avatar_url":"https://avatars.githubusercontent.com/u/10676525?v=3","gravatar_id":"","url":"https://api.github.com/users/MoritzKn","html_url":"https://github.com/MoritzKn","followers_url":"https://api.github.com/users/MoritzKn/followers","following_url":"https://api.github.com/users/MoritzKn/following{/other_user}","gists_url":"https://api.github.com/users/MoritzKn/gists{/gist_id}","starred_url":"https://api.github.com/users/MoritzKn/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/MoritzKn/subscriptions","organizations_url":"https://api.github.com/users/MoritzKn/orgs","repos_url":"https://api.github.com/users/MoritzKn/repos","events_url":"https://api.github.com/users/MoritzKn/events{/privacy}","received_events_url":"https://api.github.com/users/MoritzKn/received_events","type":"User","site_admin":false},"created_at":"2016-07-21T20:59:46Z","updated_at":"2016-07-21T20:59:46Z","body":"At least I can point you to the code:\r\nThe star is added in the `DocBlockrAtom.prototype.create_snippet` function in [docblockr-worker.js L995](https://github.com/nikhilkalige/docblockr/blob/master/lib/docblockr-worker.js#L995).\r\n\r\n**Some Explanation:**\r\n\r\n* `this.prefix` is `\"*\"`\r\n* `out` is an array with the lines. For example it could be `['@param {number} x','@return']`\r\n* `snippet` contains the comment which will be added"}}
{"actor":{"display_login":"MoritzKn"}}