Skip to content

Commit

Permalink
doxygen fix
Browse files Browse the repository at this point in the history
  • Loading branch information
Pentarctagon committed May 28, 2024
1 parent 7061e08 commit a228794
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions src/preferences/preferences.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -772,13 +772,13 @@ class prefs

std::string get_system_username();
/**
* Encrypts the value of @a plaintext using @a key and a hard coded IV using AES.
* Max size of @a plaintext must not be larger than 1008 bytes.
* Encrypts the value of @a text using @a key and a hard coded IV using AES.
* Max size of @a text must not be larger than 1008 bytes.
*
* NOTE: This is not meant to provide strong protections against a determined attacker.
* This is meant to hide the passwords from malware scanning files for passwords, family/friends poking around, etc.
*
* @param plaintext The original unencrypted data.
* @param text The original unencrypted data.
* @param key The value to use to encrypt the data. See build_key() for key generation.
* @return secure_buffer The encrypted data.
*/
Expand Down

0 comments on commit a228794

Please sign in to comment.