Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

More examples in read me please #3

Open
bubnenkoff opened this issue Oct 21, 2015 · 1 comment
Open

More examples in read me please #3

bubnenkoff opened this issue Oct 21, 2015 · 1 comment

Comments

@bubnenkoff
Copy link

Marco, big thanks for your Json parser, but could you add move examples in readme of how it's can be used?

@mleise
Copy link
Collaborator

mleise commented Oct 28, 2015

Yes documentation is a problem. I've seen people generate documentation from source code comments and upload that to their website. That way you don't need to keep source comments and a readme in sync. Also when the library grows the readme will become monolithic, so I kept it down to some basic examples for now.
Anyways what you can expect is only JSON deserialization either from file or a string. Normally it checks for correctness the parts of JSON you use, but not those you skip (with skipValue or singleKey). You can also configure it in 2 other ways with a compile-time argument: trustedSource = assume correct JSON, don't validate; validateAll = Acts like most JSON parsers and validates everything during parsing. If you only want to validate and not use the JSON data, there are convenience functions for that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants