{"action":"closed","issue":{"url":"https://api.github.com/repos/jbeder/yaml-cpp/issues/381","repository_url":"https://api.github.com/repos/jbeder/yaml-cpp","labels_url":"https://api.github.com/repos/jbeder/yaml-cpp/issues/381/labels{/name}","comments_url":"https://api.github.com/repos/jbeder/yaml-cpp/issues/381/comments","events_url":"https://api.github.com/repos/jbeder/yaml-cpp/issues/381/events","html_url":"https://github.com/jbeder/yaml-cpp/issues/381","id":155636748,"number":381,"title":"Documentation","user":{"login":"Phlosioneer","id":4657718,"avatar_url":"https://avatars.githubusercontent.com/u/4657718?v=3","gravatar_id":"","url":"https://api.github.com/users/Phlosioneer","html_url":"https://github.com/Phlosioneer","followers_url":"https://api.github.com/users/Phlosioneer/followers","following_url":"https://api.github.com/users/Phlosioneer/following{/other_user}","gists_url":"https://api.github.com/users/Phlosioneer/gists{/gist_id}","starred_url":"https://api.github.com/users/Phlosioneer/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Phlosioneer/subscriptions","organizations_url":"https://api.github.com/users/Phlosioneer/orgs","repos_url":"https://api.github.com/users/Phlosioneer/repos","events_url":"https://api.github.com/users/Phlosioneer/events{/privacy}","received_events_url":"https://api.github.com/users/Phlosioneer/received_events","type":"User","site_admin":false},"labels":[],"state":"closed","locked":false,"assignee":null,"milestone":null,"comments":1,"created_at":"2016-05-19T01:33:10Z","updated_at":"2016-05-28T18:45:42Z","closed_at":"2016-05-28T18:45:42Z","body":"The documentation of this library seems woefully incomplete. CodeDocs / doxygen is a good start, but it only shows the structure of the project. It doesn't show any explanation of what classes do, what methods do, etc.\r\n\r\nFor an example, look [here](https://codedocs.xyz/jbeder/yaml-cpp/classYAML_1_1Emitter.html). There's no explanation of what the emitter class does, the details of the methods, whether there are any corner cases, how to detect and recover from errors... It doesn't even include the operator<< overloads for the class.\r\n\r\nLooking at the actual file, there's also next to no comments to document the header file. The declaration list is separated into categories by some comments, that's it. No explanation of methods at all. No comments inside of template methods, either.\r\n\r\nI would be willing to try and document a lot of the codebase - but I don't think I could do it without help, and I don't want to start working on something that might not even be wanted."}}
{"actor":{"display_login":"jbeder"}}