Skip to content

Conversation

@devin-ai-integration
Copy link

Add Doxygen Documentation for Public APIs

Added comprehensive Doxygen documentation for 44 previously undocumented public APIs in wolftpm/tpm2_wrap.h, including:

  • HMAC functions (HmacStart, HmacUpdate, HmacFinish)
  • CSR functions (CSR_SetCustomExt, CSR_SetKeyUsage, CSR_SetSubject)
  • Handle management functions (UnloadHandles, UnloadHandles_AllTransient)
  • Policy functions (PolicyAuthorizeMake, PolicyPassword, PolicyAuthValue)
  • Firmware upgrade functions (FirmwareUpgradeHash, FirmwareUpgrade, FirmwareUpgradeRecover, FirmwareUpgradeCancel)

Each API documentation includes:

  • Brief description
  • Return value descriptions
  • Parameter descriptions
  • Related function references

Testing: Documentation-only changes, no functional changes to test.

Link to Devin run: https://app.devin.ai/sessions/eed294a2c85949d4b8af03ef716e8920
Requested by: [email protected]

@devin-ai-integration
Copy link
Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add "(aside)" to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@dgarske dgarske self-assigned this Feb 17, 2025
\sa wolfTPM2_LoadEccPrivateKey_ex
\sa wolfTPM2_LoadPrivateKey
*/
/*!
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add new line above the doxygen section for each new one added. This allows for easier readability.

@dgarske dgarske closed this Feb 22, 2025
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.

2 participants