{"action":"created","issue":{"url":"https://api.github.com/repos/Wikunia/brackets-FuncDocr/issues/57","labels_url":"https://api.github.com/repos/Wikunia/brackets-FuncDocr/issues/57/labels{/name}","comments_url":"https://api.github.com/repos/Wikunia/brackets-FuncDocr/issues/57/comments","events_url":"https://api.github.com/repos/Wikunia/brackets-FuncDocr/issues/57/events","html_url":"https://github.com/Wikunia/brackets-FuncDocr/issues/57","id":80637175,"number":57,"title":"refresh comments with the shortcut","user":{"login":"adricorse","id":6782202,"avatar_url":"https://avatars.githubusercontent.com/u/6782202?v=3","gravatar_id":"","url":"https://api.github.com/users/adricorse","html_url":"https://github.com/adricorse","followers_url":"https://api.github.com/users/adricorse/followers","following_url":"https://api.github.com/users/adricorse/following{/other_user}","gists_url":"https://api.github.com/users/adricorse/gists{/gist_id}","starred_url":"https://api.github.com/users/adricorse/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/adricorse/subscriptions","organizations_url":"https://api.github.com/users/adricorse/orgs","repos_url":"https://api.github.com/users/adricorse/repos","events_url":"https://api.github.com/users/adricorse/events{/privacy}","received_events_url":"https://api.github.com/users/adricorse/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":1,"created_at":"2015-05-25T19:18:42Z","updated_at":"2015-05-25T19:31:41Z","closed_at":null,"body":"Hello (Oh nooo ;) )\r\nWhen you have already generate PHPDoc, take this exemple and you generate this :\r\n```php\r\n<?php\r\nfunction hello(){\r\nreturn true;\r\n}\r\n?>\r\n```\r\n\r\nThe FuncDocr will generate this :\r\n```php\r\n<?php\r\n/**\r\n * [[Description]]\r\n * @return boolean [[Description]]\r\n */\r\nfunction hello(){\r\n    return true;\r\n}\r\n?>\r\n```\r\nBut, now, replace \"true\" with something else, like \"$var\" and you use shortcut to regenerate PHPDocs.\r\nThe PHPDoc is again \"return boolean\".\r\n\r\n```php\r\n<?php\r\n/**\r\n * [[Description]]\r\n * @return boolean [[Description]]\r\n */\r\nfunction hello(){\r\n    return $var;\r\n}\r\n?>\r\n```\r\nBut if you start by \"return $var\" and end by \"return true\", the PHPDoc is correct.\r\nGood luck ;)"},"comment":{"url":"https://api.github.com/repos/Wikunia/brackets-FuncDocr/issues/comments/105294130","html_url":"https://github.com/Wikunia/brackets-FuncDocr/issues/57#issuecomment-105294130","issue_url":"https://api.github.com/repos/Wikunia/brackets-FuncDocr/issues/57","id":105294130,"user":{"login":"Wikunia","id":4931746,"avatar_url":"https://avatars.githubusercontent.com/u/4931746?v=3","gravatar_id":"","url":"https://api.github.com/users/Wikunia","html_url":"https://github.com/Wikunia","followers_url":"https://api.github.com/users/Wikunia/followers","following_url":"https://api.github.com/users/Wikunia/following{/other_user}","gists_url":"https://api.github.com/users/Wikunia/gists{/gist_id}","starred_url":"https://api.github.com/users/Wikunia/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Wikunia/subscriptions","organizations_url":"https://api.github.com/users/Wikunia/orgs","repos_url":"https://api.github.com/users/Wikunia/repos","events_url":"https://api.github.com/users/Wikunia/events{/privacy}","received_events_url":"https://api.github.com/users/Wikunia/received_events","type":"User","site_admin":false},"created_at":"2015-05-25T19:31:41Z","updated_at":"2015-05-25T19:31:41Z","body":"I'm sorry that one is normal. The reason is the following:\r\nIf you have the following code:\r\n\r\n```\r\nfunction hello(b,a){\r\n    if (b > a) {\r\n        return false;\r\n    }\r\n    return true;\r\n}\r\n```\r\nThe return type will be `boolean`.\r\nIt isn't obvious that this change always returns a `boolean` as well:\r\n```\r\nfunction hello(b,a){\r\n    $bool = true;\r\n    if (b > a) {\r\n        $bool = false;\r\n    }\r\n    return $bool;\r\n}\r\n```\r\nIf you update the code the `type` which was set will stay the same (for type and description), cause sometimes it isn't easily possible to determine the type, so I rely on the `type` which is already inside the documentation. Hope you know what I mean, sorry for my bad explanation. "}}