{"action":"opened","issue":{"url":"https://api.github.com/repos/CMPUT301F15T02/Xperts/issues/43","labels_url":"https://api.github.com/repos/CMPUT301F15T02/Xperts/issues/43/labels{/name}","comments_url":"https://api.github.com/repos/CMPUT301F15T02/Xperts/issues/43/comments","events_url":"https://api.github.com/repos/CMPUT301F15T02/Xperts/issues/43/events","html_url":"https://github.com/CMPUT301F15T02/Xperts/issues/43","id":114751826,"number":43,"title":"Generate Documentation","user":{"login":"hammadj","id":7143583,"avatar_url":"https://avatars.githubusercontent.com/u/7143583?v=3","gravatar_id":"","url":"https://api.github.com/users/hammadj","html_url":"https://github.com/hammadj","followers_url":"https://api.github.com/users/hammadj/followers","following_url":"https://api.github.com/users/hammadj/following{/other_user}","gists_url":"https://api.github.com/users/hammadj/gists{/gist_id}","starred_url":"https://api.github.com/users/hammadj/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/hammadj/subscriptions","organizations_url":"https://api.github.com/users/hammadj/orgs","repos_url":"https://api.github.com/users/hammadj/repos","events_url":"https://api.github.com/users/hammadj/events{/privacy}","received_events_url":"https://api.github.com/users/hammadj/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/CMPUT301F15T02/Xperts/labels/docs","name":"docs","color":"84b6eb"}],"state":"open","locked":false,"assignee":null,"milestone":{"url":"https://api.github.com/repos/CMPUT301F15T02/Xperts/milestones/1","html_url":"https://github.com/CMPUT301F15T02/Xperts/milestones/Project%20Part%204%20-%20Half-Way%20Prototype","labels_url":"https://api.github.com/repos/CMPUT301F15T02/Xperts/milestones/1/labels","id":1390309,"number":1,"title":"Project Part 4 - Half-Way Prototype","description":"Project Part 4 -- Half-Way Prototype\r\n\r\nThis project part focuses on a working prototype with about half of the requirements.\r\n\r\nDeliverables\r\n\r\nCode Base of Prototype:\r\nYour system will be demonstrated in the lab and its source code will be inspected. The code should conform to some consistent coding convention. At this point, your prototype should be implemented to provide something tangible to the user, supporting about half the requirements. Deliver the source code to your source repository.\r\n\r\nThe code base must be synchronized with the test cases and the requirements spec and the UML diagrams.\r\n\r\nCode Documentation:\r\nFor each source code file, you should have a brief introductory comment describing its purpose or role within the application or a design pattern, as well as any currently outstanding issues. Provide Javadoc interface documentation for your use cases and basic command classes and their public methods (at least). Deliver the compiled Javadoc documentation to your source repository.\r\n\r\nTest Cases:\r\nProvide JUnit test cases for your use cases. The interface to your model should be complete (and documented, above); however, the implementation need not be complete. Applying test-driven development, the test suite should test every step of every use case (not only the working part). Some tests will obviously fail because of incomplete functionality, and that is fine. Deliver the test code to your source repository. If you have test data files, also include those. Test the use cases and ensure that the intent of the use case is encoded in the use case tests.\r\n\r\nObject-Oriented Design:\r\nUpdate your object-oriented design using a UML class diagram (or diagrams), including detail on key attributes and methods. Include notes on the use of design patterns among the classes. The diagram(s) may be reverse engineered from the code, but must be edited, arranged, and selective (not a raw dump). The diagram(s) must be neat and tidy, and drawn well using tools like eUML2 and dia and embedded as image(s) in your team wiki. The diagram(s) will likely evolve.\r\n\r\nRelease Planning:\r\nPlan the major use cases and user stories that need to be done for project part 5. This plan will likely evolve and should be maintained up-to-date in your team wiki. It should be clear from the plan the progress towards satisfying all the specified requirements.\r\n\r\nReuse Statement:\r\nDocument instances of software reuse. Give proper credit to the original developers. Obtain approval for the use of third-party libraries as appropriate. Enter this information in your team wiki.","creator":{"login":"hammadj","id":7143583,"avatar_url":"https://avatars.githubusercontent.com/u/7143583?v=3","gravatar_id":"","url":"https://api.github.com/users/hammadj","html_url":"https://github.com/hammadj","followers_url":"https://api.github.com/users/hammadj/followers","following_url":"https://api.github.com/users/hammadj/following{/other_user}","gists_url":"https://api.github.com/users/hammadj/gists{/gist_id}","starred_url":"https://api.github.com/users/hammadj/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/hammadj/subscriptions","organizations_url":"https://api.github.com/users/hammadj/orgs","repos_url":"https://api.github.com/users/hammadj/repos","events_url":"https://api.github.com/users/hammadj/events{/privacy}","received_events_url":"https://api.github.com/users/hammadj/received_events","type":"User","site_admin":false},"open_issues":21,"closed_issues":0,"state":"open","created_at":"2015-11-03T01:41:19Z","updated_at":"2015-11-03T06:31:53Z","due_on":"2015-11-06T07:00:00Z","closed_at":null},"comments":0,"created_at":"2015-11-03T06:31:52Z","updated_at":"2015-11-03T06:31:52Z","closed_at":null,"body":"Make sure all the code is properly documented and export the javadocs website to the git repo"}}