Skip to content

Conversation

@FSMaxB
Copy link
Collaborator

@FSMaxB FSMaxB commented Nov 10, 2017

The goal of this pull request is to rewrite the documentation in a more structured way that can also be somewhat used as a reference to look something up and contains all the gotchas.

Although the current style of "letter to the user" has its appeal, the kind of questions I have been getting over the time and that appeared on StackOverFlow make me think that a different approach should be taken.

Feel free to take a look at this work in progress and give some feedback.

@FSMaxB
Copy link
Collaborator Author

FSMaxB commented Nov 10, 2017

TODO:

  • Explain the data structure
  • Explain parsing
  • Explain printing
  • Explain how to work with the data structure (adding/removing items to/from arrays/objects etc.)
  • Full example
  • More information about building on Windows
  • Other things

@FSMaxB FSMaxB changed the base branch from master to develop November 15, 2017 17:06
@FSMaxB FSMaxB added this to the 1.7 milestone Nov 15, 2017
@FSMaxB FSMaxB force-pushed the new-documentation branch 3 times, most recently from 0233298 to 4ddb0cc Compare December 20, 2017 01:48
@PerMalmberg
Copy link

This is a great improvement of the old, rather sparse, documentation.

@FSMaxB
Copy link
Collaborator Author

FSMaxB commented Dec 28, 2017

@PerMalmberg Good to hear, that's exactly what I was going for.

@FSMaxB
Copy link
Collaborator Author

FSMaxB commented Dec 28, 2017

While writing the documentation I noticed the horrible cJSON_Add macros (what Dave called "auto mode"). I intend to replace them with functions that return booleans instead of deprecating them in the documentation. (this is what is still blocking me from 1.7 at the moment.)

@PerMalmberg
Copy link

@FSMaxB I'll take functions instead of macros any day. 👍

@FSMaxB FSMaxB force-pushed the new-documentation branch 3 times, most recently from 465ebea to 99c669f Compare December 30, 2017 01:25
@FSMaxB
Copy link
Collaborator Author

FSMaxB commented Dec 30, 2017

Done! Release 1.7 will probably come tomorrow or as a new years gift.

@FSMaxB FSMaxB changed the title WIP: New documentation New documentation Dec 30, 2017
@FSMaxB FSMaxB merged commit 43754e7 into develop Dec 31, 2017
@FSMaxB FSMaxB deleted the new-documentation branch February 1, 2018 00:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants