docs: improve C++ function documentation and code organization#263
Draft
skidder wants to merge 1 commit into
Draft
docs: improve C++ function documentation and code organization#263skidder wants to merge 1 commit into
skidder wants to merge 1 commit into
Conversation
skidder
changed the title
- Fix inaccurate function parameter references in doc comments - Add comprehensive documentation for constants, enums, and structs - Standardize section organization across all C++ source files - Fix typo in thumbhash.hpp function parameter name - Clean up duplicate extern C blocks in opencv.hpp - Enhance code readability with consistent comment formatting
skidder
force-pushed
the
improve-cpp-documentation
branch
from
35b64fc to
910b5f8
Compare
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Fix C++ documentation inaccuracies and improve consistency
What Changed
webp_encoder_createwas referencing a non-existent parameter)opqaue_frame→opaque_frameavcodec.cppandavif.cppextern "C"blocks inopencv.hppWhy
The existing doc comments had several inaccuracies that could confuse developers, and many functions/constants lacked documentation entirely. This makes the codebase more maintainable and easier to work with.
Files
avcodec.cpp,avif.cpp,giflib.hpp,opencv.hpp,thumbhash.cpp,thumbhash.hpp,webp.cppNo functional changes - documentation only.