Create comprehensive manpages for dns_cache.h and socks5.h #9
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 PR adds comprehensive manual pages for the DNS cache and SOCKS5 library functions, addressing the documentation gap for these core components.
Changes Made
DNS Cache Documentation (
dns_cache.3)src/gwproxy/dns_cache.hgwp_dns_cache_init,gwp_dns_cache_free,gwp_dns_cache_housekeep,gwp_dns_cache_getent,gwp_dns_cache_putent,gwp_dns_cache_insert,gwp_dns_cache_entget_i4,gwp_dns_cache_entget_i6SOCKS5 Documentation (
socks5.3)src/gwproxy/socks5.hgwp_socks5_ctx_init,gwp_socks5_ctx_free,gwp_socks5_auth_reload,gwp_socks5_conn_alloc,gwp_socks5_conn_free,gwp_socks5_conn_handle_data,gwp_socks5_conn_cmd_connect_resIndividual Function Access
man gwp_dns_cache_initorman gwp_socks5_ctx_initFormat and Style
mancommand to ensure proper formattingFiles Added
man/dns_cache.3- Main DNS cache documentationman/socks5.3- Main SOCKS5 documentationThe manpages provide developers with comprehensive documentation for using these libraries, including function signatures, parameter descriptions, return values, usage notes, and examples of the data structures involved.
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.