Title: Lack of Documentation · Issue #40 · msgpack/msgpack-java · GitHub
Open Graph Title: Lack of Documentation · Issue #40 · msgpack/msgpack-java
X Title: Lack of Documentation · Issue #40 · msgpack/msgpack-java
Description: Hello, I've been trying to use msgpack-java for a project of mine, and I keep having to look at the source code and trace through methods to try and understand how things work together. The main problem is that almost nothing outside of ...
Open Graph Description: Hello, I've been trying to use msgpack-java for a project of mine, and I keep having to look at the source code and trace through methods to try and understand how things work together. The main pr...
X Description: Hello, I've been trying to use msgpack-java for a project of mine, and I keep having to look at the source code and trace through methods to try and understand how things work together. The mai...
Opengraph URL: https://github.com/msgpack/msgpack-java/issues/40
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Lack of Documentation","articleBody":"Hello,\nI've been trying to use msgpack-java for a project of mine, and I keep having to look at the source code and trace through methods to try and understand how things work together. The main problem is that almost nothing outside of the main MessagePack class is documented.\n\nLet's take a concrete example : I wanted to implement my own serializer for a certain type. I figured I would need to subclass Template after a while. However, I quickly hit this problem :\nWhat does the parametrized argument in read method of Template actually do ?\n\nIt took me a while to figure out it was to use with Unpacker.read(T to) . Had it been documented as such with javadoc, I wouldn't have had to fiddle for so long. \n\nAnother question : what is the difference between the annotations Message and MessagePackMessage ? What do the annotations Beans, Delegate, OrdinalEnum and their respective MessagePack\\* do ?\n\nI hope those questions can be answered, and hopefully their docs will be integrated into the javadoc.\n","author":{"url":"https://github.com/roblabla","@type":"Person","name":"roblabla"},"datePublished":"2013-08-07T19:38:45.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":9},"url":"https://github.com/40/msgpack-java/issues/40"}
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:ef23240e-f199-b0c7-a828-0fd4002b6c8e |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | 9F18:11304E:16B4962:1F48453:6A53DF4E |
| html-safe-nonce | 21656e924da0580efb09ad8b4bc36a18a8d058849db2d7fc1aff348dc20f5598 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI5RjE4OjExMzA0RToxNkI0OTYyOjFGNDg0NTM6NkE1M0RGNEUiLCJ2aXNpdG9yX2lkIjoiNjA5NTYzMzUzOTIyMjcyNDQzMCIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | ecca78a0f4b2b9fb99239482af5202b93f34aca48bffdb8305f4be1e10eb2dad |
| hovercard-subject-tag | issue:17769082 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/msgpack/msgpack-java/40/issue_layout |
| twitter:image | https://opengraph.githubassets.com/9ab0f79d80c654ad236278ec17ed1ea8e0be50c3333cd1045c42278d4a4065d6/msgpack/msgpack-java/issues/40 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/9ab0f79d80c654ad236278ec17ed1ea8e0be50c3333cd1045c42278d4a4065d6/msgpack/msgpack-java/issues/40 |
| og:image:alt | Hello, I've been trying to use msgpack-java for a project of mine, and I keep having to look at the source code and trace through methods to try and understand how things work together. The main pr... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | roblabla |
| hostname | github.com |
| expected-hostname | github.com |
| None | b9a586c06a05a7a86fc7e3f4dbd03e42f6869085879aa184aa6369456dbd50fb |
| turbo-cache-control | no-preview |
| go-import | github.com/msgpack/msgpack-java git https://github.com/msgpack/msgpack-java.git |
| octolytics-dimension-user_id | 198264 |
| octolytics-dimension-user_login | msgpack |
| octolytics-dimension-repository_id | 1971346 |
| octolytics-dimension-repository_nwo | msgpack/msgpack-java |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 1971346 |
| octolytics-dimension-repository_network_root_nwo | msgpack/msgpack-java |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 07a982c1d40157c619b364352b704c3ce66bb332 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width