{"action":"opened","issue":{"url":"https://api.github.com/repos/emberjs/ember-inspector/issues/378","labels_url":"https://api.github.com/repos/emberjs/ember-inspector/issues/378/labels{/name}","comments_url":"https://api.github.com/repos/emberjs/ember-inspector/issues/378/comments","events_url":"https://api.github.com/repos/emberjs/ember-inspector/issues/378/events","html_url":"https://github.com/emberjs/ember-inspector/issues/378","id":84613633,"number":378,"title":"Add comment blocks to classes/methods/properties","user":{"login":"teddyzeenny","id":1061742,"avatar_url":"https://avatars.githubusercontent.com/u/1061742?v=3","gravatar_id":"","url":"https://api.github.com/users/teddyzeenny","html_url":"https://github.com/teddyzeenny","followers_url":"https://api.github.com/users/teddyzeenny/followers","following_url":"https://api.github.com/users/teddyzeenny/following{/other_user}","gists_url":"https://api.github.com/users/teddyzeenny/gists{/gist_id}","starred_url":"https://api.github.com/users/teddyzeenny/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/teddyzeenny/subscriptions","organizations_url":"https://api.github.com/users/teddyzeenny/orgs","repos_url":"https://api.github.com/users/teddyzeenny/repos","events_url":"https://api.github.com/users/teddyzeenny/events{/privacy}","received_events_url":"https://api.github.com/users/teddyzeenny/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":0,"created_at":"2015-06-03T15:10:11Z","updated_at":"2015-06-03T15:10:11Z","closed_at":null,"body":"Part of https://github.com/emberjs/ember-inspector/issues/360\r\n\r\nUse YUI format to comment on all classes/methods/properties.\r\n\r\nClasses, methods, and properties should have a detailed description above them about what they do and how they are used. If a method/property is clearly self descriptive, no description is needed.\r\n\r\nClasses need the `@namespace` and `@class` keywords.\r\nMethods need the `@method method-name`, `@param {Type} name Description`, `@return {Type} Description` keywords.\r\nProperties need  the `@property property-name`, `@type {Type}`, `@default default-value`.\r\n\r\nComputed properties are `@property` (not `@method`).\r\n\r\nExample:\r\n```js\r\n// app/adapters/basic.js\r\n\r\nconst { Object: EmberObject } = Ember;\r\n\r\n/**\r\n * This is the parent adapter to be extended by all other adapters. \r\n * It provides an abstraction to keep the code browser/environment agnostic. \r\n * Adapters are instantiated and injected into Ember objects automatically. \r\n * Properties and methods in this parent class need to be overridden.\r\n * \r\n * @namespace Adapters\r\n * @class Basic\r\n */\r\nexport default EmberObject.extend({\r\n\r\n  /**\r\n   * Inspect a specific DOM element. This usually means using\r\n   * the current environment's tools to inspector the element in the DOM tree.\r\n   *\r\n   * For example, in Chrome, `inspect(elem)` will open the Elements tab in dev tools\r\n   * and highlight the element.\r\n   *\r\n   * @method inspectElement\r\n   * @param {DOM Element} elem\r\n   */\r\n  inspectElement function(/* elem */) {},\r\n\r\n  /**\r\n   * Indicates whether the current environment\r\n   * supports opening up a specific file for debugging.\r\n   * An example is opening up a resource in the Chrome\r\n   * Devtools \"Sources\" panel.\r\n   *\r\n   * @property canOpenResource\r\n   * @type {Boolean}\r\n   * @default false\r\n   */\r\n  canOpenResource: false\r\n});\r\n```\r\n\r\n"}}