Documentation and code cleanup #193
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
petervdonovan
approved these changes
Apr 15, 2023
There was a problem hiding this comment.
Thank you for deleting the duplicated documentations and some of the unconventional uses of header files. It is nice to see the number of LOC go down a bit. I also agree that it is good to remove non-API things from tag.h; this was a significant missing part of #189.
lhstrh
reviewed
Apr 16, 2023
lhstrh
reviewed
Apr 16, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a starting point to clean up the APIs and their docs for user-facing APIs. It includes a number of code organization changes, including removing variables and functions from user scope. PR #1696 should be merged first, or else some tests will fail.
This first step focuses mainly on tag.h and tag.c. The generated doxygen docs are much better, now suitable for pointing users to them. This PR is already big enough that I think we should merge this incrementally. I.e., merge this now, then continue by picking the next part of the API, such as target.h, to work on.