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

Add missing macros in README and link to docs for more info #4582

Merged
merged 7 commits into from
Jan 3, 2025

Conversation

nikhilreddydev
Copy link
Contributor

@nikhilreddydev nikhilreddydev commented Jan 3, 2025

As described in #4260, made below changes

  1. Added missing macros in README and link to docs for more info
  2. Added missing @brief macro tags
  3. Changed order of non-intrusive macros to match intrusive macros
  4. Added nav items for ...only_serialize macros in documentation

Pull request checklist

Read the Contribution Guidelines for detailed information.

  • Changes are described in the pull request, or an existing issue is referenced.
  • The test suite compiles and runs without error.
  • Code coverage is 100%. Test cases can be added by editing the test suite.
  • The source code is amalgamated; that is, after making changes to the sources in the include/nlohmann directory, run make amalgamate to create the single-header files single_include/nlohmann/json.hpp and single_include/nlohmann/json_fwd.hpp. The whole process is described here.

@nikhilreddydev
Copy link
Contributor Author

nikhilreddydev commented Jan 3, 2025

@nlohmann @gregmarr
I have added @brief macro tags but not sure about the @since tags
can you please let me know the versions to add.

@coveralls
Copy link

coveralls commented Jan 3, 2025

Coverage Status

coverage: 99.639%. remained the same
when pulling 6365a58 on nikhilreddydev:develop
into a6255cc on nlohmann:develop.

Copy link

github-actions bot commented Jan 3, 2025

🔴 Amalgamation check failed! 🔴

The source code has not been amalgamated. @nikhilreddydev
Please read and follow the Contribution Guidelines.

@nlohmann
Copy link
Owner

nlohmann commented Jan 3, 2025

I have added @brief macro tags but not sure about the @since tags can you please let me know the versions to add.

The version when the macro was added should be in the detail pages of the macros (see https://json.nlohmann.me/api/macros/ for an overview). If there is no version mentioned or the version is unknown, just add @since version 3.11.x.

README.md Outdated Show resolved Hide resolved
Signed-off-by: Nikhil <nikhilreddydev@gmail.com>
Signed-off-by: Nikhil <nikhilreddydev@gmail.com>
Signed-off-by: Nikhil <nikhilreddydev@gmail.com>
Signed-off-by: Nikhil <nikhilreddydev@gmail.com>
Signed-off-by: Nikhil <nikhilreddydev@gmail.com>
Signed-off-by: Nikhil <nikhilreddydev@gmail.com>
This reverts commit 4c9b3ae.

Signed-off-by: Nikhil <nikhilreddydev@gmail.com>
Copy link
Owner

@nlohmann nlohmann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

@nlohmann nlohmann added this to the Release 3.11.4 milestone Jan 3, 2025
@nlohmann nlohmann merged commit 60c4875 into nlohmann:develop Jan 3, 2025
124 checks passed
@nlohmann
Copy link
Owner

nlohmann commented Jan 3, 2025

Thanks! I will adjust the README in #4560.

@nikhilreddydev
Copy link
Contributor Author

Thanks! I will adjust the README in #4560.

Sure.
Thank you for merging this. I'm happy to see my first contribution getting merged. Looking forward for more contributions.

slowriot pushed a commit to slowriot/json that referenced this pull request Jan 10, 2025
…#4582)

* Add nav items for serialize macros

Signed-off-by: Nikhil <nikhilreddydev@gmail.com>

* match order of non-intrusive macros to intrusive macros

Signed-off-by: Nikhil <nikhilreddydev@gmail.com>

* Add missing macros and link for more info

Signed-off-by: Nikhil <nikhilreddydev@gmail.com>

* Add @brief macro tags

Signed-off-by: Nikhil <nikhilreddydev@gmail.com>

* make amalgamate

Signed-off-by: Nikhil <nikhilreddydev@gmail.com>

* Add since version tags

Signed-off-by: Nikhil <nikhilreddydev@gmail.com>

* Revert "Add missing macros and link for more info"

This reverts commit 4c9b3ae.

Signed-off-by: Nikhil <nikhilreddydev@gmail.com>

---------

Signed-off-by: Nikhil <nikhilreddydev@gmail.com>
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