{"action":"opened","issue":{"url":"https://api.github.com/repos/phetsims/trig-tour/issues/27","labels_url":"https://api.github.com/repos/phetsims/trig-tour/issues/27/labels{/name}","comments_url":"https://api.github.com/repos/phetsims/trig-tour/issues/27/comments","events_url":"https://api.github.com/repos/phetsims/trig-tour/issues/27/events","html_url":"https://github.com/phetsims/trig-tour/issues/27","id":101525165,"number":27,"title":"Incorrect documentation formatting","user":{"login":"jessegreenberg","id":6396244,"avatar_url":"https://avatars.githubusercontent.com/u/6396244?v=3","gravatar_id":"","url":"https://api.github.com/users/jessegreenberg","html_url":"https://github.com/jessegreenberg","followers_url":"https://api.github.com/users/jessegreenberg/followers","following_url":"https://api.github.com/users/jessegreenberg/following{/other_user}","gists_url":"https://api.github.com/users/jessegreenberg/gists{/gist_id}","starred_url":"https://api.github.com/users/jessegreenberg/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jessegreenberg/subscriptions","organizations_url":"https://api.github.com/users/jessegreenberg/orgs","repos_url":"https://api.github.com/users/jessegreenberg/repos","events_url":"https://api.github.com/users/jessegreenberg/events{/privacy}","received_events_url":"https://api.github.com/users/jessegreenberg/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":{"login":"dubson","id":5090870,"avatar_url":"https://avatars.githubusercontent.com/u/5090870?v=3","gravatar_id":"","url":"https://api.github.com/users/dubson","html_url":"https://github.com/dubson","followers_url":"https://api.github.com/users/dubson/followers","following_url":"https://api.github.com/users/dubson/following{/other_user}","gists_url":"https://api.github.com/users/dubson/gists{/gist_id}","starred_url":"https://api.github.com/users/dubson/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dubson/subscriptions","organizations_url":"https://api.github.com/users/dubson/orgs","repos_url":"https://api.github.com/users/dubson/repos","events_url":"https://api.github.com/users/dubson/events{/privacy}","received_events_url":"https://api.github.com/users/dubson/received_events","type":"User","site_admin":false},"milestone":null,"comments":0,"created_at":"2015-08-17T22:42:08Z","updated_at":"2015-08-17T22:42:08Z","closed_at":null,"body":"Found during code review, #14.\r\n\r\nDocumentation is great throughout the code, but there are a few cases where it is not formatted correctly.  \r\n\r\nThere should be a new line between descriptions and annotations such as  ```@param``` and  ```@constructor``` for all documentation blocks in the code. For example: \r\n```\r\n/** \r\n * The PhetDeveloper is responsible for creating code for simulations\r\n * and documenting their code thoroughly.\r\n * \r\n * @param {string} name - full name\r\n * @param {Object} [options] - optional configuration, see constructor\r\n * @constructor\r\n */\r\n```\r\n\r\nThere should be a new line between the inherit call and the first function in the prototype and a new line before each additional function.  There are some examples in the google doc:\r\nhttps://docs.google.com/document/d/1odXkliRagq0zuf1_NdOtQ2BrkC9hwlISnPi2y-dKdrk/edit#heading=h.1oxr3ptyo50w\r\n\r\n```@public```, ```@private```, and ```@protected``` annotations should have a space before the commenting backslashes such as \r\n```\r\n    PropertySet.call( this, {\r\n      angle: 0,             // @private, total angle in radians, can be greater than 2*pi, or less than -2*pi\r\n      singularity: false    // @private, indicates singularity in tan function at theta = +/- 90 degrees\r\n                            // true if angle is close to +/-90 degrees\r\n```\r\n\r\nFunctions with lengthier descriptions or parameters should have block documentations.  For example, setFullAngleRadians could have documentation such as \r\n\r\n```\r\n/**\r\n * Set the angle, the small angle and various turns counts, given the current full angle.\r\n *\r\n * @param {number} angleInRads - total angle for the model, in radians\r\n */\r\n    setFullAngleInRadians: function( angleInRads ){\r\n      var remainderAngle = angleInRads%( 2*Math.PI );\r\n      this.fullTurnCount = Util.roundSymmetric( ( angleInRads - remainderAngle )/(2*Math.PI ));\r\n```\r\nThese code style guidelines should generally be applied to all of the code, but if you have any questions about where in particular the documentation could be reformatted, please let me know.\r\n"}}