Revision 2:4997f825ee95, committed 2012-10-11

Comitter:

razueroh

Date:

Thu Oct 11 17:09:23 2012 +0000

Parent:

1:0075ec28b9dd

Commit message:

Documentation fixes

Changed in this revision

diff -r 0075ec28b9dd -r 4997f825ee95 small_aes.h
--- a/small_aes.h	Wed Oct 10 22:46:20 2012 +0000
+++ b/small_aes.h	Thu Oct 11 17:09:23 2012 +0000
@@ -50,6 +50,7 @@
 * @param key The key bytes
 * @param len The Key length
 * @param dir If encrypt or decrypt
+* @return -1 if the key size is not valid; 0 otherwise.
 */
 int aesSetKey(AES* aes, const unsigned char *key, unsigned int len, int dir);
 
@@ -95,6 +96,7 @@
 * @fn unsigned int byteReverseWord32(unsigned int value)
 * @brief Converts a  big-endian 32-bit word to little-endian format
 * @param value The big-endian 32-bit word
+* @return The little-endian 32-bit word
 */
 unsigned int byteReverseWord32(unsigned int value);
 
@@ -112,6 +114,7 @@
 * @brief Rotates a 32-bit word n-bytes to the left
 * @param x The32-bit word
 * @param y The number of bytes to rotate
+* @return The rotated 32-bit word
 */
 unsigned int rotlFixed(unsigned int x, unsigned int y);
 
@@ -120,6 +123,7 @@
 * @brief Rotates a 32-bit word n-bytes to the right
 * @param x The 32-bit word
 * @param y The number of bytes to rotate
+* @return The rotated 32-bit word
 */
 unsigned int rotrFixed(unsigned int x, unsigned int y);