{ "id": "128566", "key": "ALOY-977", "fields": { "issuetype": { "id": "4", "description": "An improvement or enhancement to an existing feature or task.", "name": "Improvement", "subtask": false }, "project": { "id": "11113", "key": "ALOY", "name": "Alloy", "projectCategory": { "id": "10400", "description": "Tools for developing applications", "name": "Tooling" } }, "fixVersions": [ { "id": "16692", "name": "Alloy 1.7.0", "archived": false, "released": true, "releaseDate": "2015-07-22" } ], "resolution": { "id": "1", "description": "A fix for this issue is checked into the tree and tested.", "name": "Fixed" }, "resolutiondate": "2014-12-30T19:33:57.000+0000", "created": "2014-04-01T20:08:56.000+0000", "epic": { "id": 128563, "key": "ALOY-974", "name": "Document Alloy", "summary": "Document Alloy", "color": { "key": "color_1" }, "done": false }, "priority": { "name": "Medium", "id": "3" }, "labels": [], "versions": [], "issuelinks": [], "assignee": { "name": "skypanther", "key": "skypanther", "displayName": "Tim Poulsen", "active": true, "timeZone": "America/New_York" }, "updated": "2014-12-30T19:33:57.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": "Add comments to the alloy scripts, specifically to the compile-related files. Code comment structure should be compatible with the TBD code-doc tool.", "attachment": [], "flagged": false, "summary": "Add code comments", "creator": { "name": "skypanther", "key": "skypanther", "displayName": "Tim Poulsen", "active": true, "timeZone": "America/New_York" }, "subtasks": [], "reporter": { "name": "skypanther", "key": "skypanther", "displayName": "Tim Poulsen", "active": true, "timeZone": "America/New_York" }, "environment": null, "closedSprints": [ { "id": 303, "state": "closed", "name": "2014 Sprint 26 Tooling", "startDate": "2014-12-22T18:27:33.520Z", "endDate": "2014-12-30T18:27:00.000Z", "completeDate": "2015-01-05T18:12:12.168Z", "originBoardId": 121 } ], "comment": { "comments": [ { "id": "299661", "author": { "name": "skypanther", "key": "skypanther", "displayName": "Tim Poulsen", "active": true, "timeZone": "America/New_York" }, "body": "Candidate tools include:\n\n* Docco\n* Gilt (a fork of Groc which is a fork of Docco https://github.com/gilt/groc)\n* Flatdoc (not best for code documentation as it works with separate markdown files rather than inline code comments)\n* JSDuck \n* YUIDoc, or JSDocs", "updateAuthor": { "name": "skypanther", "key": "skypanther", "displayName": "Tim Poulsen", "active": true, "timeZone": "America/New_York" }, "created": "2014-04-02T22:51:52.000+0000", "updated": "2014-04-02T22:51:52.000+0000" }, { "id": "336630", "author": { "name": "skypanther", "key": "skypanther", "displayName": "Tim Poulsen", "active": true, "timeZone": "America/New_York" }, "body": "This ticket could be never-ending. But I've made a PR that includes code comments and readme files. These are at least a good start. Ongoing, all new code should be commented.\r\n\r\nPR https://github.com/appcelerator/alloy/pull/636\r\n\r\nThe code comments are not implemented to specifically work with any of the tools listed in my previous comment. Alloy doesn't lend itself particularly well to automated source code documentation, as it's not an API or library. ", "updateAuthor": { "name": "skypanther", "key": "skypanther", "displayName": "Tim Poulsen", "active": true, "timeZone": "America/New_York" }, "created": "2014-12-16T20:35:26.000+0000", "updated": "2014-12-16T20:37:30.000+0000" }, { "id": "337659", "author": { "name": "skypanther", "key": "skypanther", "displayName": "Tim Poulsen", "active": true, "timeZone": "America/New_York" }, "body": "PR merged", "updateAuthor": { "name": "skypanther", "key": "skypanther", "displayName": "Tim Poulsen", "active": true, "timeZone": "America/New_York" }, "created": "2014-12-30T19:33:57.000+0000", "updated": "2014-12-30T19:33:57.000+0000" } ], "maxResults": 4, "total": 4, "startAt": 0 } } }