1
0
Fork 0
mirror of https://github.com/eosswedenorg/libantelope synced 2026-06-19 04:50:03 +02:00

Adding/Updating comments in public header files.

This commit is contained in:
Henrik Hautakoski 2020-05-19 14:55:57 +02:00
parent 45ae0b5791
commit b619ab78d4
5 changed files with 71 additions and 9 deletions

View file

@ -29,16 +29,29 @@
namespace libeosio {
/**
* Base58 Encoding functions.
*/
std::string base58_encode(const std::string& str);
std::string base58_encode(const std::vector<unsigned char>& vch);
std::string base58_encode(const unsigned char* pbegin, const unsigned char* pend);
/**
* Returns true if `ch` is a base58 character, false otherwise.
*/
bool is_base58(char ch);
// Returns std::string::npos if the string contains only base58 characters
// Otherwise the position of the first non base58 character is returned.
/**
* Returns std::string::npos if the string contains only base58 characters
* Otherwise the position of the first non base58 character is returned.
*/
size_t is_base58(const std::string& str);
/**
* Strips all non-base58 characters from `str`.
* The string is modified in place and the same string is
* returned without non-base58 chars.
*/
std::string& base58_strip(std::string& str);
} //namespace eoskeygen