{"action":"created","issue":{"url":"https://api.github.com/repos/SassDoc/sassdoc/issues/386","labels_url":"https://api.github.com/repos/SassDoc/sassdoc/issues/386/labels{/name}","comments_url":"https://api.github.com/repos/SassDoc/sassdoc/issues/386/comments","events_url":"https://api.github.com/repos/SassDoc/sassdoc/issues/386/events","html_url":"https://github.com/SassDoc/sassdoc/issues/386","id":63030249,"number":386,"title":"Add ability to document functions, mixins options","user":{"login":"pascalduez","id":335467,"avatar_url":"https://avatars.githubusercontent.com/u/335467?v=3","gravatar_id":"","url":"https://api.github.com/users/pascalduez","html_url":"https://github.com/pascalduez","followers_url":"https://api.github.com/users/pascalduez/followers","following_url":"https://api.github.com/users/pascalduez/following{/other_user}","gists_url":"https://api.github.com/users/pascalduez/gists{/gist_id}","starred_url":"https://api.github.com/users/pascalduez/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/pascalduez/subscriptions","organizations_url":"https://api.github.com/users/pascalduez/orgs","repos_url":"https://api.github.com/users/pascalduez/repos","events_url":"https://api.github.com/users/pascalduez/events{/privacy}","received_events_url":"https://api.github.com/users/pascalduez/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":9,"created_at":"2015-03-19T16:29:11Z","updated_at":"2015-04-06T15:05:35Z","closed_at":null,"body":"A [tweet](https://twitter.com/elseloop/status/578583630164848640) points out there is no way to document a Map as parameter currently. \r\nThat might be an interesting new feature to add.\r\n\r\nConsider the following:\r\n```sass\r\n/// Sowieso\r\n/// @param {Map} $options [()] - some options\r\n@mixn whatever($options: ()) { ... }\r\n```\r\nThere's no way to properly document the options map properties.\r\n\r\nSome possible solutions (just to illustrate the matter):\r\n\r\nIntroduce a new annotation\r\n```sass\r\n/// Sowieso\r\n/// @options $options - some options\r\n///    @prop {Number} one [1]- option one\r\n///    @prop {String} two ['two'] - option two\r\n@mixn whatever($options: ()) { ... }\r\n```\r\nPro: straightforward\r\nCon: How to deal with indentation, nesting\r\n\r\nReference a Map outside the caller\r\n```sass\r\n/// Sowieso\r\n/// @type {Option Map}\r\n/// @prop {Number} one [1]- option one\r\n/// @prop {String} two ['two'] - option two\r\n$options: ( one: 1, two: 'two' );\r\n\r\n/// Sowieso\r\n/// @options $options - some options\r\n@mixn whatever($options: ()) { ... }\r\n```\r\nPro: \r\nCon: Weirdo, complex\r\n\r\nEDIT: Was already reported in #111 "},"comment":{"url":"https://api.github.com/repos/SassDoc/sassdoc/issues/comments/90093892","html_url":"https://github.com/SassDoc/sassdoc/issues/386#issuecomment-90093892","issue_url":"https://api.github.com/repos/SassDoc/sassdoc/issues/386","id":90093892,"user":{"login":"ajmueller","id":1442179,"avatar_url":"https://avatars.githubusercontent.com/u/1442179?v=3","gravatar_id":"","url":"https://api.github.com/users/ajmueller","html_url":"https://github.com/ajmueller","followers_url":"https://api.github.com/users/ajmueller/followers","following_url":"https://api.github.com/users/ajmueller/following{/other_user}","gists_url":"https://api.github.com/users/ajmueller/gists{/gist_id}","starred_url":"https://api.github.com/users/ajmueller/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ajmueller/subscriptions","organizations_url":"https://api.github.com/users/ajmueller/orgs","repos_url":"https://api.github.com/users/ajmueller/repos","events_url":"https://api.github.com/users/ajmueller/events{/privacy}","received_events_url":"https://api.github.com/users/ajmueller/received_events","type":"User","site_admin":false},"created_at":"2015-04-06T15:05:35Z","updated_at":"2015-04-06T15:05:35Z","body":"I believe @pascalduez opened this issue because #111 was closed."}}