StarMirror/qTox
1
0
Fork 0
mirror of https://github.com/qTox/qTox.git synced 2024-03-22 14:00:36 +08:00
Code Issues Projects Releases Wiki Activity

added documentation

Browse Source
This commit is contained in:
marcel 2015-05-17 21:54:21 +02:00
parent 24fb67f415
commit a41765a58d
1 changed files with 14 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
src/core/toxid.h
View File

@ -3,19 +3,25 @@
#include <QString> #include <QString>
/*!
* \brief This class represents a Tox ID as specified at:
* https://libtoxcore.so/core_concepts.html
*/
class ToxId class ToxId
{ {
public: public:
ToxId(); ToxId(); ///< The default constructor. Creates an empty Tox ID.
ToxId(const ToxId& other); ToxId(const ToxId& other); ///< The copy constructor.
ToxId(const QString& id); ToxId(const QString& id); ///< Create a Tox ID from QString.
/// If the given id is not a valid Tox ID, than
/// publicKey == id and noSpam == "" == checkSum.
bool operator==(const ToxId& other) const; bool operator==(const ToxId& other) const; ///< Compares only publicKey.
bool operator!=(const ToxId& other) const; bool operator!=(const ToxId& other) const; ///< Compares only publicKey.
QString toString() const; QString toString() const; ///< Returns the Tox ID as QString.
void clear(); void clear(); ///< Clears all elements of the Tox ID.
static bool isToxId(const QString& id); static bool isToxId(const QString& id); ///< Returns true if id is a valid Tox ID.
public: public:
QString publicKey; QString publicKey;