{ "id": "99616", "key": "ALOY-199", "fields": { "issuetype": { "id": "7", "description": "gh.issue.story.desc", "name": "Story", "subtask": false }, "project": { "id": "11113", "key": "ALOY", "name": "Alloy", "projectCategory": { "id": "10400", "description": "Tools for developing applications", "name": "Tooling" } }, "fixVersions": [], "resolution": { "id": "1", "description": "A fix for this issue is checked into the tree and tested.", "name": "Fixed" }, "resolutiondate": "2012-08-27T07:51:42.000+0000", "created": "2012-08-22T11:25:34.000+0000", "priority": { "name": "High", "id": "2" }, "labels": [], "versions": [], "issuelinks": [], "assignee": null, "updated": "2018-03-07T22:26:15.000+0000", "status": { "description": "A resolution has been taken, and it is awaiting verification by reporter. From here issues are either reopened, or are closed.", "name": "Resolved", "id": "5", "statusCategory": { "id": 3, "key": "done", "colorName": "green", "name": "Done" } }, "components": [ { "id": "12327", "name": "Documentation" } ], "description": "To build the Alloy docs using JSDuck, we need to comment the classes that should be exposed, and remove any comments that look like doc comments--that is if we do this:\r\n\r\n{code}\r\n/**\r\n * Do something here.\r\n */\r\n exports._ = function() ...\r\n{code}\r\n\r\nJSDuck will add a global method called \"_\" with the description \"Do something here.\" Changing the doc comment intro {{/\\*\\*}} into a regular comment intro {{/\\*}} eliminates the rogue method.\r\n\r\nCurrently, it looks like we should be building docs from Alloy/builtins and Alloy/lib.\r\n", "attachment": [], "flagged": false, "summary": "Documentation: Make Alloy safe for documentation", "creator": { "name": "aevans", "key": "aevans", "displayName": "Arthur Evans", "active": true, "timeZone": "America/Los_Angeles" }, "subtasks": [], "reporter": { "name": "aevans", "key": "aevans", "displayName": "Arthur Evans", "active": true, "timeZone": "America/Los_Angeles" }, "environment": null, "comment": { "comments": [ { "id": "215707", "author": { "name": "aevans", "key": "aevans", "displayName": "Arthur Evans", "active": true, "timeZone": "America/Los_Angeles" }, "body": "Pull request ready:\r\nhttps://github.com/appcelerator/alloy/pull/51\r\n", "updateAuthor": { "name": "aevans", "key": "aevans", "displayName": "Arthur Evans", "active": true, "timeZone": "America/Los_Angeles" }, "created": "2012-08-22T15:43:32.000+0000", "updated": "2012-08-22T15:43:32.000+0000" }, { "id": "216171", "author": { "name": "tlukasavage", "key": "tlukasavage", "displayName": "Tony Lukasavage", "active": true, "timeZone": "America/Los_Angeles" }, "body": "merged arthur's PR and made a few small adjustments", "updateAuthor": { "name": "tlukasavage", "key": "tlukasavage", "displayName": "Tony Lukasavage", "active": true, "timeZone": "America/Los_Angeles" }, "created": "2012-08-27T07:51:42.000+0000", "updated": "2012-08-27T07:51:42.000+0000" } ], "maxResults": 2, "total": 2, "startAt": 0 } } }