Tweak file comments
List the filename at the top of the comment. Add a little more detail to comment for decrypter.js. Fix up the code block formatting in the index module comment.
Showing
3 changed files
with
13 additions
and
11 deletions
1 | /* | 1 | /* |
2 | * aes.js | ||
2 | * | 3 | * |
3 | * This file contains an adaptation of the AES decryption algorithm | 4 | * This file contains an adaptation of the AES decryption algorithm |
4 | * from the Standford Javascript Cryptography Library. That work is | 5 | * from the Standford Javascript Cryptography Library. That work is | ... | ... |
1 | /** | 1 | /* |
2 | * This file contains the `Decrypter` class which manages | 2 | * decrypter.js |
3 | * AES decryption through the `decrypt` function (which uses | 3 | * |
4 | * the `AES` class for lower level decrypting) and Asynchronous | 4 | * An asynchronous implementation of AES-128 CBC decryption with |
5 | * Streams from the `AsyncStream` class | 5 | * PKCS#7 padding. |
6 | */ | 6 | */ |
7 | 7 | ||
8 | import AES from './aes'; | 8 | import AES from './aes'; | ... | ... |
1 | /** | 1 | /* |
2 | * Main file for Decrypter so that we can neatly export | 2 | * index.js |
3 | * all of our functionality as one object in one file | 3 | * |
4 | * and we will only have to require the top level directory | 4 | * Index module to easily import the primary components of AES-128 |
5 | * in this case that would look like: | 5 | * decryption. Like this: |
6 | * ``` JavaScript | 6 | * |
7 | * ```js | ||
7 | * import {Decrypter, decrypt, AsyncStream} from './src/decrypter'; | 8 | * import {Decrypter, decrypt, AsyncStream} from './src/decrypter'; |
8 | * ``` | 9 | * ``` |
9 | */ | 10 | */ | ... | ... |
-
Please register or sign in to post a comment