{"action":"created","issue":{"url":"https://api.github.com/repos/OpenWaterAnalytics/EPANET/issues/24","labels_url":"https://api.github.com/repos/OpenWaterAnalytics/EPANET/issues/24/labels{/name}","comments_url":"https://api.github.com/repos/OpenWaterAnalytics/EPANET/issues/24/comments","events_url":"https://api.github.com/repos/OpenWaterAnalytics/EPANET/issues/24/events","html_url":"https://github.com/OpenWaterAnalytics/EPANET/issues/24","id":106401609,"number":24,"title":"New functions documentation","user":{"login":"eladsal","id":1942312,"avatar_url":"https://avatars.githubusercontent.com/u/1942312?v=3","gravatar_id":"","url":"https://api.github.com/users/eladsal","html_url":"https://github.com/eladsal","followers_url":"https://api.github.com/users/eladsal/followers","following_url":"https://api.github.com/users/eladsal/following{/other_user}","gists_url":"https://api.github.com/users/eladsal/gists{/gist_id}","starred_url":"https://api.github.com/users/eladsal/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/eladsal/subscriptions","organizations_url":"https://api.github.com/users/eladsal/orgs","repos_url":"https://api.github.com/users/eladsal/repos","events_url":"https://api.github.com/users/eladsal/events{/privacy}","received_events_url":"https://api.github.com/users/eladsal/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/OpenWaterAnalytics/EPANET/labels/documentation","name":"documentation","color":"c7def8"}],"state":"open","locked":false,"assignee":null,"milestone":{"url":"https://api.github.com/repos/OpenWaterAnalytics/EPANET/milestones/1","html_url":"https://github.com/OpenWaterAnalytics/EPANET/milestones/v2.1","labels_url":"https://api.github.com/repos/OpenWaterAnalytics/EPANET/milestones/1/labels","id":1157595,"number":1,"title":"v2.1","description":"","creator":{"login":"samhatchett","id":2386549,"avatar_url":"https://avatars.githubusercontent.com/u/2386549?v=3","gravatar_id":"","url":"https://api.github.com/users/samhatchett","html_url":"https://github.com/samhatchett","followers_url":"https://api.github.com/users/samhatchett/followers","following_url":"https://api.github.com/users/samhatchett/following{/other_user}","gists_url":"https://api.github.com/users/samhatchett/gists{/gist_id}","starred_url":"https://api.github.com/users/samhatchett/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/samhatchett/subscriptions","organizations_url":"https://api.github.com/users/samhatchett/orgs","repos_url":"https://api.github.com/users/samhatchett/repos","events_url":"https://api.github.com/users/samhatchett/events{/privacy}","received_events_url":"https://api.github.com/users/samhatchett/received_events","type":"User","site_admin":false},"open_issues":8,"closed_issues":6,"state":"open","created_at":"2015-06-09T21:24:08Z","updated_at":"2015-09-27T06:48:43Z","due_on":null,"closed_at":null},"comments":31,"created_at":"2015-09-14T18:33:56Z","updated_at":"2015-09-28T13:52:01Z","closed_at":null,"body":"Apart from the [changes documentation](https://github.com/OpenWaterAnalytics/EPANET/issues/14) I think we should document the new files added to the DLL. There are about 10 of them and I think that we could start with Wiki pages right here on GitHub."},"comment":{"url":"https://api.github.com/repos/OpenWaterAnalytics/EPANET/issues/comments/143749124","html_url":"https://github.com/OpenWaterAnalytics/EPANET/issues/24#issuecomment-143749124","issue_url":"https://api.github.com/repos/OpenWaterAnalytics/EPANET/issues/24","id":143749124,"user":{"login":"samhatchett","id":2386549,"avatar_url":"https://avatars.githubusercontent.com/u/2386549?v=3","gravatar_id":"","url":"https://api.github.com/users/samhatchett","html_url":"https://github.com/samhatchett","followers_url":"https://api.github.com/users/samhatchett/followers","following_url":"https://api.github.com/users/samhatchett/following{/other_user}","gists_url":"https://api.github.com/users/samhatchett/gists{/gist_id}","starred_url":"https://api.github.com/users/samhatchett/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/samhatchett/subscriptions","organizations_url":"https://api.github.com/users/samhatchett/orgs","repos_url":"https://api.github.com/users/samhatchett/repos","events_url":"https://api.github.com/users/samhatchett/events{/privacy}","received_events_url":"https://api.github.com/users/samhatchett/received_events","type":"User","site_admin":false},"created_at":"2015-09-28T13:52:01Z","updated_at":"2015-09-28T13:52:01Z","body":"so, as for the doxygen route: i've implemented a few doxy-compatible comment blocks in the `doxy-trial` branch. [Look in epanet2.h](https://github.com/OpenWaterAnalytics/EPANET/blob/doxy-trial/include/epanet2.h) -- The output that all this generates can be seen [here](http://samhatchett.github.io/epanet-dox/modules.html) - this will take you to the \"modules\" listing, which paginates groups of API functions to manage the complexity of the whole collection of functions.\r\n\r\nthis approach tends to expand the length of the header file, but in my view makes the whole project more usable when taken in context of having access to an IDE and a web browser. What do you think - is this a good route for auto documentation?"}}