Skip to content

Fix issues with the API documentation#9458

Merged
dgarske merged 4 commits intowolfSSL:masterfrom
LinuxJedi:doc_fixes
Dec 3, 2025
Merged

Fix issues with the API documentation#9458
dgarske merged 4 commits intowolfSSL:masterfrom
LinuxJedi:doc_fixes

Conversation

@LinuxJedi
Copy link
Copy Markdown
Member

Description

Fixes API header mismatches between API and documentation.

@devin-ai-integration
Copy link
Copy Markdown
Contributor

🛟 Devin Lifeguard found 2 likely issues in this PR

  • do-not-change-external-apis snippet snippet snippet: Restore the original prototypes (e.g., keep int wc_AesFree(Aes* aes)), and introduce new versions such as wc_AesFree_ex(Aes* aes) or similar wrappers with the updated return type/parameters, having the old functions call the new ones with default values.
  • no-void-functions snippet: Revert wc_AesFree (and any other newly-changed APIs) to return an int and ensure the implementation returns an appropriate error code so callers can detect failures.

@LinuxJedi
please take a look at the above issues which Devin flagged. Devin will not fix these issues automatically.

Comment thread doc/dox_comments/header_files/wolfio.h Outdated
Comment thread doc/dox_comments/header_files/random.h Outdated
@LinuxJedi LinuxJedi removed their assignment Dec 3, 2025
@LinuxJedi LinuxJedi requested a review from SparkiDev December 3, 2025 15:21
@dgarske
Copy link
Copy Markdown
Member

dgarske commented Dec 3, 2025

Jenkins retest this please: "PRB-fipsv2-regression-and-rolling-release-v3 #8273" "scripts/openssl.test"

@dgarske dgarske merged commit 0aa789a into wolfSSL:master Dec 3, 2025
267 of 268 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants