Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement support of @note doxygen command #84

Closed
sudden6 opened this issue May 29, 2022 · 0 comments · Fixed by #87
Closed

Implement support of @note doxygen command #84

sudden6 opened this issue May 29, 2022 · 0 comments · Fixed by #87

Comments

@sudden6
Copy link

sudden6 commented May 29, 2022

This example snippet shows a potential use of @note:

/**
 * @brief Looks up a key from the cache or computes it if it didn't exist yet.
 * @param cache Cache to perform the lookup on
 * @param public_key Public key, used for the lookup and computation.
 *
 * @return The shared key of length CRYPTO_SHARED_KEY_SIZE, matching the public key and our secret key or nullptr on error.
 * @note The cache executes a housekeeping cycle, to remove timed out keys, for the active slot on every lookup.
 */
non_null()
const uint8_t* shared_key_cache_lookup(Shared_Key_Cache *cache, const uint8_t public_key[CRYPTO_PUBLIC_KEY_SIZE]);
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 a pull request may close this issue.

1 participant