doc: improve public API header documentation #2985
Merged
Conversation
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
This commit significantly improves the documentation quality in ndpi_api.h, the main public API header file for nDPI. Changes include: 1. Fixed 11 typos: - "fucntion" → "function" - "ckeck" → "check" - "guesses" → "guessed" - "searhing" → "searching" - "@paw" → "@Par" (incorrect Doxygen tag) - "addeed" → "added" - "readeable" → "readable" (function name) - "creaign" → "creating" - "lenght" → "length" (3 occurrences) - "hosti tself" → "host itself" 2. Added comprehensive documentation for memory management functions: - ndpi_malloc(), ndpi_calloc(), ndpi_realloc() - ndpi_strdup(), ndpi_strndup() - ndpi_free() - ndpi_flow_malloc(), ndpi_flow_free() - ndpi_get_tot_allocated_memory() These critical functions were previously undocumented, which could confuse users about custom allocator support and memory tracking. 3. Documented high-priority utility functions: - ndpi_match_string_value() - automaton string matching - ndpi_strip_leading_trailing_spaces() - string trimming - ndpi_handle_risk_exceptions() - risk exception handling - set_ndpi_malloc(), set_ndpi_free() - custom allocator setup - set_ndpi_flow_malloc(), set_ndpi_flow_free() - flow allocator setup - set_ndpi_debug_function() - custom debug logging 4. Added detailed documentation for Community ID hash functions: - ndpi_flowv4_flow_hash() - IPv4 flow hashing - ndpi_flowv6_flow_hash() - IPv6 flow hashing - Added reference to Community ID specification - Clarified parameter byte ordering and buffer requirements All documentation follows Doxygen format with @param and @return tags. Build and tests verified: all tests pass (3/3). Stats: +173 lines of documentation, -19 lines (typo fixes) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
|
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 commit significantly improves the documentation quality in ndpi_api.h, the main public API header file for nDPI.
Changes include:
Fixed 11 typos:
Added comprehensive documentation for memory management functions:
These critical functions were previously undocumented, which could
confuse users about custom allocator support and memory tracking.
Documented high-priority utility functions:
Added detailed documentation for Community ID hash functions:
All documentation follows Doxygen format with @param and @return tags. Build and tests verified: all tests pass (3/3).
Stats: +173 lines of documentation, -19 lines (typo fixes)
🤖 Generated with Claude Code