Mercurial > code
changeset 356:6f0598efad07
Hash: add documentation
| author | David Demelier <markand@malikania.fr> |
|---|---|
| date | Tue, 28 Apr 2015 10:59:29 +0200 |
| parents | 9f1e9c69c223 |
| children | 3174c463af95 |
| files | C++/doc/Hash/Home.md C++/doc/Hash/class/Hash.md C++/doc/Hash/class/Hash/md5.md C++/doc/Hash/class/Hash/sha1.md C++/doc/Hash/class/Hash/sha256.md C++/doc/Hash/class/Hash/sha512.md CMakeLists.txt |
| diffstat | 7 files changed, 112 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/C++/doc/Hash/Home.md Tue Apr 28 10:59:29 2015 +0200 @@ -0,0 +1,13 @@ +# Hash + +This class provides functions for hashing strings using MD5, SHA1, SHA256 and SHA512. These functions are written upon OpenSSL, you need the library to use this class. + +## Requirements + +- [OpenSSL](http://www.openssl.org) + +## API Reference + +### Classes + +- [Hash](class/Hash.md)
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/C++/doc/Hash/class/Hash.md Tue Apr 28 10:59:29 2015 +0200 @@ -0,0 +1,16 @@ +# Hash + +The hash class, contains only static member functions. + +## Class + +````cpp +class Hash; +```` + +### Public member functions + +- [md5 (static)](Hash/md5.md) +- [sha1 (static)](Hash/sha1.md) +- [sha256 (static)](Hash/sha256.md) +- [sha512 (static)](Hash/sha512.md)
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/C++/doc/Hash/class/Hash/md5.md Tue Apr 28 10:59:29 2015 +0200 @@ -0,0 +1,19 @@ +# md5 + +Hash using MD5. + +## Function + +### SYNOPSIS + +````cpp +static std::string md5(const std::string &input); +```` + +### ARGUMENTS + +- input, the input string + +### RETURNS + +The hashed string. \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/C++/doc/Hash/class/Hash/sha1.md Tue Apr 28 10:59:29 2015 +0200 @@ -0,0 +1,19 @@ +# sha1 + +Hash using SHA1. + +## Function + +### SYNOPSIS + +````cpp +static std::string sha1(const std::string &input); +```` + +### ARGUMENTS + +- input, the input string + +### RETURNS + +The hashed string. \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/C++/doc/Hash/class/Hash/sha256.md Tue Apr 28 10:59:29 2015 +0200 @@ -0,0 +1,19 @@ +# sha256 + +Hash using SHA256. + +## Function + +### SYNOPSIS + +````cpp +static std::string sha256(const std::string &input); +```` + +### ARGUMENTS + +- input, the input string + +### RETURNS + +The hashed string. \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/C++/doc/Hash/class/Hash/sha512.md Tue Apr 28 10:59:29 2015 +0200 @@ -0,0 +1,19 @@ +# sha512 + +Hash using SHA512. + +## Function + +### SYNOPSIS + +````cpp +static std::string sha512(const std::string &input); +```` + +### ARGUMENTS + +- input, the input string + +### RETURNS + +The hashed string. \ No newline at end of file
--- a/CMakeLists.txt Tue Apr 28 10:49:26 2015 +0200 +++ b/CMakeLists.txt Tue Apr 28 10:59:29 2015 +0200 @@ -232,6 +232,13 @@ SOURCES ${code_SOURCE_DIR}/C++/modules/Hash/Hash.cpp ${code_SOURCE_DIR}/C++/modules/Hash/Hash.h + DOCS + ${code_SOURCE_DIR}/C++/doc/Hash/Home.md + ${code_SOURCE_DIR}/C++/doc/Hash/class/Hash.md + ${code_SOURCE_DIR}/C++/doc/Hash/class/Hash/md5.md + ${code_SOURCE_DIR}/C++/doc/Hash/class/Hash/sha1.md + ${code_SOURCE_DIR}/C++/doc/Hash/class/Hash/sha256.md + ${code_SOURCE_DIR}/C++/doc/Hash/class/Hash/sha512.md ) # ---------------------------------------------------------