Tirsvad
621f5f7272
- Implement decrypt function that reverses encryption with negative shift - Export decrypt in package's public API - Update tests with basic roundtrip and edge case tests - Update documentation to reflect encryption/decryption support
10 lines
460 B
Markdown
10 lines
460 B
Markdown
# Caesar Cipher – documentation
|
||
|
||
Each letter is moved `shift` places through the alphabet:
|
||
`new_position = (ALPHABET.index(letter) + shift) % 26`.
|
||
The modulo keeps positions in range for shifts past `z`.
|
||
Decryption is encryption with `-shift`. Non-letters are left untouched and letter case is preserved.
|
||
|
||
API reference: run `doxygen Doxyfile` from the repository root and open
|
||
`docs/doxygen/html/index.html`. The step-by-step plan is in [plan.md](plan.md).
|